Introduction

Use the BillPro API to manage your products, customers, orders and payments from your own systems.

It's a JSON API over HTTPS. Almost every endpoint starts with /api/v2/profiles/{profile_id}, so each request works on one merchant profile.

flowchart TB

  Auth["Authenticate
  (API token)"]
  ProfileID["Find your profile_id
  in the dashboard address"]

  Customers["Customers
  create / list"]
  Products["Products
  create / price calculate"]
  Orders["Create order
  POST /orders"]
  Collect["Collect payment
  checkout · card · payment link"]
  Live["Live order"]
  Scheduled["Scheduled payments
  retry · skip · merge · execute"]
  Payments["Payments
  capture · refund · reverse"]

  Auth --> ProfileID
  ProfileID --> Customers
  ProfileID --> Products
  Customers --> Orders
  Products --> Orders
  Orders --> Collect --> Live
  Live --> Scheduled
  Live --> Payments

Before you start

You need two things:

• An API token. In the BillPro dashboard, open the profile menu, go to Users, select your integration user and copy the token from API Token. The section only appears when the user has API Access, which only Admin users can have. To turn it on, contact BillPro.
• Your profile ID. It's in the dashboard address, after /profiles/. In /profiles/1234/orders, it's 1234.

Keep your token secret and use it only from your server. See 1 · Authenticate.

Environments

Examples and Try It in these docs use the sandbox. Switch the host to production when you go live.

Make your first request

Send these headers with every request:

     --header 'Authorization: Bearer {api_token}' \
     --header 'Content-Type: application/json' \
     --header 'Accept: application/json'

For example, list your orders:

curl --request GET \
     --url 'https://test-api.bill.pro/api/v2/profiles/{profile_id}/orders' \
     --header 'Authorization: Bearer {api_token}' \
     --header 'Accept: application/json'

Response codes

Error responses include an error message.

Lists and pages

List endpoints return 20 records a page.

• Use page to move through the results. It starts at 1. A page past the last one returns 404, and 0 or a non-number returns 400.
• Use items for up to 100 records a page, on the lists that take it. A larger value gives 100, and an invalid one gives 20.
• The response's pagination object gives the current page, the total pages and the total count.

Next steps

Follow the journey in the Overview, one stage at a time:

1. Authenticate
2. Build your catalog
3. Create customers & orders
4. Collect payment
5. Recurring billing & recovery

To find any endpoint, use search (⌘K).