List payment history

GET

https://{your_space_name}.signalwire.com/api/space/payment_history

Lists the balance adjustments recorded for the space: top-ups, auto top-ups, and credits or debits applied by SignalWire. Narrow the range with created_after and created_before. Results are paged; follow the links.next URL for the next page, which carries the filters and the page_token for you.

Permissions

Authenticate with a Personal access token whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder’s role in the space is the whole authorization decision.

Lists the balance adjustments recorded for the space: top-ups, auto top-ups, and credits or debits applied by SignalWire. Narrow the range with `created_after` and `created_before`. Results are paged; follow the `links.next` URL for the next page, which carries the filters and the `page_token` for you. #### Permissions Authenticate with a [Personal access token](/docs/apis/authorization#personal-access-tokens) whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder's role in the space is the whole authorization decision.

Authentication

AuthorizationBasic

Personal access token authentication for space-wide administration.

Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project’s: it is created from your user menu in the Dashboard, is prefixed pat_, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space.

Example:

Authorization: Basic base64(:pat_...)

Personal access token authentication for space-wide administration. Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project's: it is created from your user menu in the Dashboard, is prefixed `pat_`, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space. Example: ``` Authorization: Basic base64(:pat_...) ```

Query parameters

created_afterstringOptional

Return only adjustments recorded after this date (YYYY-MM-DD) or ISO 8601 timestamp.

created_beforestringOptional

Return only adjustments recorded before this date (YYYY-MM-DD) or ISO 8601 timestamp.

page_sizeintegerOptional1-1000Defaults to 50

The number of results per page.

page_numberintegerOptional>=0Defaults to 0

The page index. Any value above 0 also requires page_token.

page_tokenstringOptional

The cursor for any page after the first, taken from the links.next URL of the previous response.

Response

The request has succeeded.

linksobject

Pagination links for the list. The created_after and created_before filters are preserved in each link.

datalist of objects

The balance adjustments on this page.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error