Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
RecurringCharge

Retrieves the collection of RecurringCharge resources.

Retrieves the collection of RecurringCharge resources.

get/recurring_charges

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

RecurringCharge collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

namestring nullable

Name of the recurring charge

srcIdstring nullable

Unique identifier for each recurring charge

apiClientIdstring nullable

API key for the app the charge is associated with

priceinteger nullable

The price of the recurring application charge

statusstring nullable

The status of the recurring charge e.g. "Pending" e.g. "Accepted"

returnUrlstring nullable

The URL where the merchant is redirected afteraccepting the charge

billingDatestring date-time nullable

The date and time when the customer is billed

createdstring date-time nullable

The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z"

modifiedstring date-time nullable

The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z"

activationDatestring date-time nullable

The date and time when the customer activated the recurring charge

cancellationDatestring date-time nullable

The date and time when the merchant cancelled their recurring charge

trialDaysinteger nullable

The number of days that the customer is eligible for a free trial

trialEndsOnstring date-time nullable

The date and time when the free trial ends

decoratedReturnUrlstring nullable

The display URL where the merchant is redirected after accepting a charge

Example response

[
  {
    "integration": "quickbooks",
    "name": "Monthly Rental",
    "srcId": "982000000567240",
    "apiClientId": "aa2e-87c43f2a32a9",
    "price": 1200,
    "status": "Pending",
    "returnUrl": "www.example.com",
    "billingDate": "2021-07-28",
    "created": "2021-07-28 00:00:00",
    "modified": "2021-07-28 00:00:00",
    "activationDate": "2021-06-28",
    "cancellationDate": "2021-08-28",
    "trialDays": 12,
    "trialEndsOn": "2021-07-09",
    "decoratedReturnUrl": "https://www.example.com"
  }
]