New test environment for the BILL v2 API
BILL is introducing a more stable sandbox environment for you to continue testing with the BILL v2 API - https://api-stage.bill.com/api/v2/. In addition, we have migrated the developer keys of all current API customers to the new environment.
On August 31, 2024, BILL will sunset the current sandbox environment. To continue testing with the BILL v2 API, set up a test organization in the new environment and start making your v2 API calls with the new base URL. See the next set of sections in this email for more information.
NOTE
August 31, 2024 onwards, after the current sandbox environment is sunset, your test data in the current sandbox environment will not be available.
This change does not affect any integrations in the BILL production environment.
URL changes
The API base URL and web app URL is changing as part of introducing the new sandbox environment.
| Current URL | New URL | |
|---|---|---|
| Base URL | https://api-sandbox.bill.com/api/v2/ | https://api-stage.bill.com/api/v2/ |
| Web app URL | https://app-sandbox.bill.com/login | https://login.stage.us.bill.com/neo/login |
Developer actions
Now that the developer key migration is complete, you can take advantage of testing with the new sandbox environment.
Complete the provided set of recommended steps.
- Sign up and create a new BILL developer account at https://www-test.bill.com/signup?env=stage. Make sure that you enter the email address you use for your current sandbox developer account.
- Select Accounts Payable & Receivable and click Get Started to complete your BILL account activation flow. This includes adding a valid phone number for the two-step verification process.
- When your sign-up is complete, you land on the Get started section. You can continue testing with BILL features. For example, adding a vendor, bill, customer, and invoice.
- At any point, you can sign in to your developer account at https://login.stage.us.bill.com/neo/login with your created user name (email address) and password.
API sign in credentials
Set the required fields to sign in with /v2/Login.json.
| Field | Description |
|---|---|
userName | Your username is the email address used to sign in to your BILL developer account. |
passsword | Your password is used to sign in to your BILL developer account. |
devKey | Your developer key is used to identify your developer account in your API requests. Set this value as your current developer key. |
orgId | Your BILL developer account represents your test organization in BILL. The organization ID is a unique alphanumeric value that begins with 008.The simplest method to get your organization ID is with /v2/ListOrgs.json. |
Sample /v2/ListOrgs.json request
curl --request POST \
--url 'https://api-stage.bill.com/api/v2/ListOrgs.json' \
--header 'accept: application/json' \
--header 'content-type: application/x-www-form-urlencoded' \
--data 'userName={email_address}' \
--data 'password={password}' \
--data 'devKey={developer_key}'
Sample /v2/Login.json request
curl --request POST \
--url 'https://api-stage.bill.com/api/v2/Login.json' \
--header 'accept: application/json' \
--header 'content-type: application/x-www-form-urlencoded' \
--data 'userName={username}' \
--data 'password={password}' \
--data 'devKey={developer_key}' \
--data 'orgId={organization_id}'
After signing in, you can continue testing with BILL v2 API operations, including adding a vendor, creating a bill, and submitting a payment. For questions or concerns, email us at [email protected].