PIpiriod
Billing

Partial update subscription

patch/subscriptions/{id}/

Request

Request body

idstring
customerstring required

Customer ID.

documentinteger required

Document type ID used to issue invoices.

date_startstring date required
next_billingstring date required
previous_billingstring date nullable
billing_cyclesinteger nullable

Total cycles or null for indefinite.

next_billing_cycleinteger
expiration_daysinteger

Days until invoices generated by this subscription expire.

collection_scheme'send_invoice' | 'charge_payment'
default_sourcestring nullable

Default payment source ID. Required when collection_scheme=charge_payment.

custom_changenumber nullable

Custom currency conversion factor for issued invoices.

couponstring nullable

Coupon ID applied at the subscription (invoice-level) scope.

coupon_redemptionsinteger
require_referenceboolean
notestring nullable
orgunitinteger nullable
status'active' | 'paused' | 'cancelled' | 'finalized' | 'needs_attention'
status_descriptionstring nullable
needs_attentionstring date-time nullable
needs_attention_reason'biller_issue' | 'gateway_issue' | 'reference_expired' | 'without_usage_records' | 'processing_issue' | 'without_reference' nullable
cancel_reason'custom' | 'fraud_review_failed' | 'insolvency' | 'no_card' | 'non_compliant_customer' | 'not_paid' | 'not_specified' | 'shutdown_ops' nullable
cancelledstring date-time nullable
pausedstring date-time nullable
paused_reason'not_specified' | 'non_compliant_customer' | 'custom' nullable
pause_untilstring date nullable
test_modeboolean
createdstring date-time
updatedstring date-time

Response

Updated subscription.

idstring
customerstring required

Customer ID.

documentinteger required

Document type ID used to issue invoices.

date_startstring date required
next_billingstring date required
previous_billingstring date nullable
billing_cyclesinteger nullable

Total cycles or null for indefinite.

next_billing_cycleinteger
expiration_daysinteger

Days until invoices generated by this subscription expire.

collection_scheme'send_invoice' | 'charge_payment'
default_sourcestring nullable

Default payment source ID. Required when collection_scheme=charge_payment.

custom_changenumber nullable

Custom currency conversion factor for issued invoices.

couponstring nullable

Coupon ID applied at the subscription (invoice-level) scope.

coupon_redemptionsinteger
require_referenceboolean
notestring nullable
orgunitinteger nullable
status'active' | 'paused' | 'cancelled' | 'finalized' | 'needs_attention'
status_descriptionstring nullable
needs_attentionstring date-time nullable
needs_attention_reason'biller_issue' | 'gateway_issue' | 'reference_expired' | 'without_usage_records' | 'processing_issue' | 'without_reference' nullable
cancel_reason'custom' | 'fraud_review_failed' | 'insolvency' | 'no_card' | 'non_compliant_customer' | 'not_paid' | 'not_specified' | 'shutdown_ops' nullable
cancelledstring date-time nullable
pausedstring date-time nullable
paused_reason'not_specified' | 'non_compliant_customer' | 'custom' nullable
pause_untilstring date nullable
test_modeboolean
createdstring date-time
updatedstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.