Skip to main content

BillingHistoryResponse

successbooleanrequired
data object

Response payload for successful operations.

items object[]required
  • Array [
    • invoiceIdstring<uuid>required
    subscriptionIdstring<uuid>required
    attemptNumberintegerrequired

    Possible values: >= 1

    amountintegerrequired

    Possible values: >= 1

    currencyCurrencyCode (string)required

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Examples:
    Example: USD
    statusstringrequired

    Possible values: [PAID, FAILED, PENDING]

    failureReasonstringnullable
    billedAtstring<date-time>required
  • ]
    • errorstring

    Machine-readable error code.

    messagestring

    Human-readable response message.

    BillingHistoryResponse
    {
      "success": true,
      "data": {
        "items": [
          {
            "invoiceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "attemptNumber": 0,
            "amount": 0,
            "currency": "USD",
            "status": "PAID",
            "failureReason": "string",
            "billedAt": "2024-07-29T15:51:28.071Z"
          }
        ]
      },
      "error": "string",
      "message": "string"
    }