Get Billings

POST

https://api.staple.io/v1/billings

POST

/v1/billings

$ curl -X POST https://api.staple.io/v1/billings \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json"

200Get Billings

1 {
2   "getBilling": {
3     "billing": {
4       "address": "Duong Quang Ham, Go Vap",
5       "city": "HCM",
6       "country": "vn",
7       "phoneNumber": "0992929292",
8       "postCode": "70000"
9     },
10     "card": {
11       "brand": null,
12       "exp_month": null,
13       "exp_year": null,
14       "id": null,
15       "last4": null,
16       "name": null
17     },
18     "invoice": {
19       "items": [
20         {
21           "created": "3/6/2020",
22           "number": "CAFE6839-0001",
23           "total": "0"
24         }
25       ],
26       "next": null,
27       "prev": null
28     },
29     "subscription": {
30       "id": "sub_HZs9UoUIPHTXd8",
31       "nextBilling": "Aug 3, 2020",
32       "plans": [
33         {
34           "amount": "0",
35           "currency": "usd",
36           "id": "STAPLE_DEVELOPER_FREE",
37           "interval": "month",
38           "name": "Developer Free Monthly",
39           "subsItem": "si_HZs9ph3VkObBkR",
40           "usageType": "metered"
41         }
42       ],
43       "total": "0"
44     }
45   }
46 }

Get your billing information including subscription plan information, next billing date, invoices, payment card information and billing contact details.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Request

This endpoint expects an object.

invoiceLimitintegerOptional

Authentication

Request

Response