COconfirmo
Payments

Get a payment by ID

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

Request

  • Base URL
    https://api.confirmo.com
  • URL
    https://api.confirmo.com/api/v3/subscriptions/payments/{paymentId}
  • Auth
    HTTP bearer

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
}

Changes

No recorded changes to this operation across all 2 revisions of this API.