Checkout Page
Support
Log inSign up

Get subscription payment details

Returns one subscription payment by ID — a single charge in a subscription billing cycle, including its payment and invoice status, billing reason, payment method, and Stripe references. To list every payment on a subscription, use the list endpoint with subscriptionId.

GET/v1/subscription-payments/:subscriptionPaymentId

Authorization

api_key_auth
AuthorizationBearer <token>

API key authentication. Use "Bearer YOUR_API_KEY" format.

In: header

Path Parameters

subscriptionPaymentId*string

The ID of the subscription payment to retrieve. Use the list subscription payments endpoint first if you need to discover an ID — filter by subscriptionId to see every payment on one subscription.

Match^[0-9a-fA-F]{24}$

Query Parameters

livemode?string

Set to false to return test-mode records created while a page was in test mode. Defaults to the mode of the API key. Test API keys can only read test data.

Value in"true" | "false"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.checkoutpage.com/v1/subscription-payments/:subscriptionPaymentId"
{
  "data": {
    "id": "507f1f77bcf86cd799439011",
    "subscriptionId": "string",
    "customerId": "string",
    "pageId": "string",
    "productId": "string",
    "sellerId": "string",
    "transactionIds": [
      "string"
    ],
    "customerEmail": "string",
    "customerName": "string",
    "productTitle": "string",
    "pageSlug": "string",
    "currency": "usd",
    "amount": 0,
    "amountUsd": 0,
    "livemode": true,
    "paymentStatus": "succeeded",
    "invoiceStatus": "draft",
    "paid": true,
    "refunded": true,
    "partiallyRefunded": true,
    "billingReason": "manual",
    "paymentMethod": {
      "gateway": "stripe",
      "method": "string",
      "wallet": "string",
      "mode": "default",
      "brand": "string",
      "last4": "string",
      "country": "string",
      "exp_month": 0,
      "exp_year": 0,
      "expMonth": 0,
      "expYear": 0,
      "funding": "string"
    },
    "stripeSubscriptionId": "string",
    "stripePaymentId": "string",
    "stripePaymentIntentId": "string",
    "stripeInvoiceId": "string",
    "stripeInvoicePdf": "string",
    "stripeRefundInvoicePdf": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}