v1

latestOpenAPI 3.1.02026-07-24104338.0 KB

Payments

Get a payment by ID

get/api/v3/subscriptions/payments/{paymentId}

Path parameters

paymentIdstring uuid required

Response

Payment found.

idstring uuid required

subscriptionIdstring uuid required

status'PENDING' | 'SUCCEEDED' | 'FAILED' required

PENDING — charge initiated, not yet settled. SUCCEEDED — charge settled successfully. FAILED — charge did not settle.

paidAtinteger

Unix epoch seconds.

cycleNumberinteger required

Which billing cycle this payment belongs to.

createdAtinteger required

Unix epoch seconds.

Example response

{
  "billedAmount": {
    "amount": "29.00",
    "asset": "USD"
  },
  "paidAmount": {
    "amount": "29.00",
    "asset": "USD"
  },
  "paidAt": 1748513400,
  "createdAt": 1748513400
}