v1

latestOpenAPI 3.0.02026-07-2671142187.3 KB

Subscriptions

Mark payment paid

Manually update a declined payment as approved (e.g. if payment was collected elsewhere)

patch/subscriptions/{subscriptionId}/payments/{paymentNumber}

subscriptionIdinteger required

The subscription id

paymentNumberinteger required

The recurring payment number quantifying when the subscription was billed. For example a subscription's third billing has payment number 3.

api-tokenstring required

Your API access token for authentication and access to the Helcim API

statusinteger required

The updated payment status. Must be included and specified as approved to register the payment for update. All other status values will be rejected.

{
  "status": "approved"
}

Successful payment update. The response body contains the newly approved payment and the parent subscription.

idinteger

dateCreatedstring date-time

dateUpdatedstring date-time

dateActivatedstring date

dateBillingstring date

statusstring

paymentPlanIdinteger

customerCodestring

timesBilledinteger

setupAmountnumber float

recurringAmountnumber float

freeTrialPeriodinteger

maxCyclesinteger

hasFailedPaymentsstring

addOnIdsinteger[]