Billing

Get invoice of specific year and month for the tenant

Fetch invoices for a tenant, in a specific month and year.

Note: This API is not applicable for system tenants.

get/_api/billing/invoices/{year}/{month}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/billing/invoices/:year/:month/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

yearinteger required

Year in 'YYYY' format.

monthinteger required

Month. Valid values:[1..12]

Headers

tenantstring string

Tenant name. If not set it uses the tenant invoking the request.

Response

Successfully fetched invoice details.

Example - https://stripe.com/docs/api/invoices/retrieve

Note: the example here is an excerpt please follow the link above for a complete example.

idstring

objectstring

account_countrystring

account_namestring

account_tax_idsobject

amount_dueinteger

amount_paidinteger

amount_remaininginteger

Example response

{
  "id": "ID",
  "object": "invoice",
  "account_country": "US",
  "account_name": "Stripe.com",
  "amount_due": 40298,
  "amount_remaining": 40298
}

Changes

No recorded changes to this operation across all 1 revision of this API.