Sign in
Invoice Preview

Preview invoice lines for a contract period.

post/v2/contracts/{contract_id}/invoice-preview

Path parameters

contract_idstring required

Request body

period_start_atinteger required

Unix timestamp in seconds.

period_end_atinteger required

Unix timestamp in seconds.

Example request

{
  "period_start_at": 1767225600,
  "period_end_at": 1767225600
}

Response

Success.

contract_idstring required

LedgerUp resource identifier.

period_start_atinteger required

Unix timestamp in seconds.

period_end_atinteger required

Unix timestamp in seconds.

currency_codestring required

Example response

{
  "period_start_at": 1767225600,
  "period_end_at": 1767225600,
  "lines": [
    {
      "invoice_group_key": "usage_credits",
      "service_period_start_at": 1767225600,
      "service_period_end_at": 1767225600
    }
  ]
}

Changes

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