Billing

Preview a subscription invoice using its effective billing terms

post/api/v1/billing.subscriptions.invoice-preview.get

Request

  • Base URL: https://api.partly.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.partly.com/api/v1/billing.subscriptions.invoice-preview.get
  • Auth: none declared. Required headers: authorization

Headers

authorizationstring required

UTF-8 encoded string

Request body

billing_monthstring

UTF-8 encoded string

period_startstring date-time nullable

DateTime at a given timezone (RFC3339 format)

subscription_idstring uuid required

UUID value type

subscription_period_idstring uuid

UUID value type

Response

200 OK

can_issueboolean required

Boolean value

currency_idstring uuid required

UUID value type

due_datestring date-time required

DateTime at a given timezone (RFC3339 format)

eligible_atstring date-time required

DateTime at a given timezone (RFC3339 format)

period_endstring date-time required

DateTime at a given timezone (RFC3339 format)

period_startstring date-time required

DateTime at a given timezone (RFC3339 format)

subscription_idstring uuid required

UUID value type

subscription_period_idstring uuid

UUID value type

subtotal_amountstring required

UTF-8 encoded string

tax_amountstring required

UTF-8 encoded string

total_amountstring required

UTF-8 encoded string

Changes

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