API sign up process
In this section, we walk through the steps to sign up and join the BILL developer program.
API sandbox sign up process
You can test with the BILL API in the sandbox environment. Begin with setting up your API sandbox developer account.
- Your BILL sales representative or account manager reaches out to discuss your objectives. In addition, they walk you through creating your API sandbox developer account.
- After creating your account, set your password and sign in to your BILL sandbox web app. This account also represents your BILL organization in the API sandbox environment.
- The BILL team provisions API access to your account. In a separate email, we send you the required information for your API login.
Sign in credentials | Description |
---|---|
Username | Your username is the email address used to sign in to your API sandbox developer account. |
Password | Your password is used to sign in to your API sandbox developer account. |
Organization ID | Your API sandbox developer account represents your organization in BILL. The organization ID is a unique alphanumeric value that begins with 008 . |
Developer key | Your developer key is used to uniquely identify your developer account in your API requests. |
Sandbox API base URL | https://api-stage.bill.com/api/v2/ |
When your API sign up process is complete, you can sign in to your API sandbox developer account with the /Login.json
API endpoint. See Sandbox sign in for more information.
Retrieve organization ID with the API
You can retrieve the organization ID (orgId
) linked to your API sandbox account with /v2/ListOrgs.json
. Set the required values in the cURL command example and run the command in your choice of command line system.
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 'devKey={developer_key}' \
--data 'userName={email_address}' \
--data 'password={password}'
In the response, the orgId
and orgName
values are retrieved. See Retrieve organizations for the current user for more information.
Production sign up process
Your go-live application is available to your customers in the production environment.
As you continue to build and test your application in the API sandbox environment, reach out to your BILL account manager and set up your production account when you are ready to build your application in the production environment.
Updated 28 days ago