Update - Paygentic

Authorizations

Authorization

string

header

required

API key authentication

Path Parameters

string

required

Body

application/json

endingAt

string<date-time>

status

enum<string>

Available options:

active,

terminated

terminatedAt

string<date-time>

Effective termination timestamp. Capped at the current effective time (future values are clamped). Must be strictly after the subscription's start date — values at or before startedAt are rejected with 400.

terminatedBy

string

Identifier of entity that cancelled the subscription. Sample values: 'cust_abc123' for customer-initiated cancellation, 'org_xyz789' for merchant-initiated cancellation

terminationReason

string

Explanation for subscription cancellation. Sample values: 'Customer requested cancellation', 'Payment failure', 'Service migration', 'Contract expiration'

autoCharge

boolean

Enable or disable automatic charging of invoices using stored payment methods.

taxExempt

boolean

When true, forces tax rate to 0%.

minimumAccountBalance

string

Minimum wallet balance requirement in decimal dollars (e.g., '100.00'). Can be set to '0' to disable. Maximum allowed is $5,000. Contact support for higher limits. Note: If the calculated charge amount at renewal is below payment processor minimums (typically $1.00), it will be automatically adjusted upward to meet the minimum requirement. Changes apply at next renewal.

renewalReminderEnabled

boolean | null

Override plan setting for renewal reminder emails. Set to true to enable, false to disable, or null to use plan default.

renewalReminderDays

integer | null

Override plan setting for number of days before renewal to send the reminder. Set to null to use plan default.

Required range: 1 <= x <= 30

paymentTermDays

integer

Payment term in days ("Net X") applied to subsequently generated invoices: invoice dueAt = invoice issue date + paymentTermDays. A non-zero value is only valid alongside bankTransferOnly=true. Set 0 for "due on issue". Already-issued invoices keep their snapshotted dueAt.

Required range: 0 <= x <= 365

Response

Subscription updated

string

required

object

enum<string>

required

Available options:

subscription

merchantId

string

required

The merchant organization that owns this subscription, equal to the customer's merchant.

Pattern: ^org_[a-zA-Z0-9]+$

createdAt

string<date-time>

required

customerId

string

required

name

string

required

planId

string

required

startedAt

string<date-time>

required

status

enum<string>

required

Available options:

pending_payment,

active,

terminated

updatedAt

string<date-time>

required

paymentTermDays

integer

required

Payment term in days ("Net X") snapshotted onto every invoice the subscription generates (invoice dueAt = invoice issue date + paymentTermDays). Defaults to 0 ("due on issue"); a non-zero value is only set on bankTransferOnly subscriptions.

Required range: 0 <= x <= 365

autoCharge

boolean

default:false

Whether automatic charging is enabled for this subscription. When true, invoices will be automatically paid using stored payment methods.

endingAt

string<date-time>

estimatedTaxRate

number

Projected tax percentage rate. Sample values: 8.875 indicates 8.875% tax rate, 10.0 indicates 10% tax rate, 0 indicates no tax applied

taxExempt

boolean

default:false

When true, tax rate is forced to 0%.

payment

object

Payment session details when upfront payment is required, or confirmation of a zero-amount paid invoice

Option 1
Option 2
Option 3

Show child attributes

prefundAmount

string

@deprecated Use minimumAccountBalance instead. Minimum required wallet balance in atomic units. Sample values: '200000000000' equals $200.00 minimum, '1000000000000' equals $1000.00 minimum

minimumAccountBalance

string

Minimum wallet balance requirement in nanodollars. Can be '0' to disable. The system calculates the difference between this minimum and the customer's current balance, charging only what's needed to reach the minimum. Note: If the calculated charge amount is below payment processor minimums (typically $1.00), the actual charged amount may be automatically adjusted upward to meet the minimum requirement. Sample values: '200000000000' equals $200.00 minimum, '1000000000000' equals $1000.00 minimum

terminatedAt

string<date-time>

terminatedBy

string

ID of who terminated the subscription (customer ID or merchant ID)

terminationReason

string

Reason for termination

testClockId

string

Test clock ID if this subscription is attached to a test clock. Only present in non-production environments.

walletId

string

Optional (virtual) wallet ID for the subscription

renewalReminderEnabled

boolean | null

Whether renewal reminder emails are enabled for this subscription. Null means use plan default.

renewalReminderDays

integer | null

Number of days before renewal to send the reminder. Null means use plan default.

autoApprove

boolean | null

Subscription-level auto-approval override. Null means plan default is used.

metadata

object

Free-form merchant metadata to attach to the subscription. Values must be strings, numbers, or booleans.

Show child attributes

customer

object

Customer details with merchant and consumer information. Only included when include=customer is specified in the list query.

Show child attributes