Download a statement as PDF

GET

https://{your_space_name}.signalwire.com/api/space/billing_statement.pdf

Redirects to the stored PDF of one month’s statement. The response is a 302 whose Location header is the download URL, so your client must follow redirects.

Only a closed month has a PDF. The current month is rejected with pdf_requires_a_closed_month; check formats in List statement periods before requesting one.

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.

Redirects to the stored PDF of one month's statement. The response is a `302` whose `Location` header is the download URL, so your client must follow redirects. Only a closed month has a PDF. The current month is rejected with `pdf_requires_a_closed_month`; check `formats` in [List statement periods](/docs/apis/rest/space/billing/list-billing-statements) before requesting one. #### 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

monthstringRequiredformat: "^\d{4}-\d{2}$"

The calendar month, as YYYY-MM. A month before the space existed is rejected with month_precedes_space_creation, and a future month with month_is_in_the_future.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error

502

Bad Gateway Error