Skip to main content Link Search Menu Expand Document (external link)
Ongoing Subscriptions API

Billing Attempts

Billing attempts list

GET “https://app.ongoingsubscriptions.com/api/v1/billing-attempts”

Description

Get a paginated list of all Billing Attempts

Request Params

  • page number

    Example: 2

Example Response 

{
  "billingAttempts": [
    {
      "subscriptionUuid": "gid://shopify/SubscriptionContract/12345",
      "shopifyId": "gid://shopify/SubscriptionBillingAttempt/876543210",
      "status": "SUCCESS",
      "errorCode": null,
      "errorMessage": null,
      "failureAt": null,
      "successAt": "2022-06-03 16:01:42",
      "createdAt": "2022-06-03 16:01:34",
      "updatedAt": "2022-06-03 16:01:42",
      "completedAt": "2022-06-03 16:01:42"
    },
    {
      "subscriptionUuid": "gid://shopify/SubscriptionContract/23456",
      "shopifyId": "gid://shopify/SubscriptionBillingAttempt/987654321",
      "status": "FAILURE",
      "errorCode": "PAYMENT_METHOD_DECLINED",
      "errorMessage": "Your card has insufficient funds.",
      "failureAt": "2022-06-03 16:01:42",
      "successAt": null,
      "createdAt": "2022-06-03 16:01:34",
      "updatedAt": "2022-06-03 16:01:42",
      "completedAt": "2022-06-03 16:01:42"
    },
    {
      "subscriptionUuid": "gid://shopify/SubscriptionContract/34567",
      "shopifyId": "gid://shopify/SubscriptionBillingAttempt/987654321",
      "status": "PENDING",
      "errorCode": null,
      "errorMessage": null,
      "failureAt": null,
      "successAt": null,
      "createdAt": "2022-06-03 16:01:34",
      "updatedAt": "2022-06-03 16:01:42",
      "completedAt": "2022-06-03 16:01:42"
    },
    "....."
  ],
  "pagination": {
    "hasNextPage": true,
    "lastPage": 59,
    "page": 2,
    "totalResults": 16
  },
  "message": "Billing attempts fetched successfully.",
  "errors": false
}