Manage the billing address on file and preview what a partner will be charged.
Manage the billing address on file and preview what a partner will be charged.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | Get the billing address | Get the latest saved billing address for a user (with its city -> state -> country chain). |
POST | Save the billing address | Create or updates (on the user's latest row) the billing address for user_id. |
POST | Preview partner charges | Returns a partner-level checkout preview for a plan: the plan pricing plus the count and list of the partner's active/pending stores (where the store's who_will_pay is partner) that the plan would apply to. |