put
https://app.shuttleglobal.com/c/api/instances/{instance_key}/contracts/
Update specific properties of a contract. The following fields can be modified:
- next_charge: Next charge date or 'now'
- occurrences: Total number of charges
- next_payment: Next payment attempt date
- payment_method: New payment method ID
- amount: New charge amount (creates new contract)
- resume: Resume cancelled contract
- scheduled_date: New schedule date
- status: SUSPENDED/ACTIVE
- metadata: Custom key-value pairs stored on the contract
- alt_key: Your reference for the contract
- description: Payment description
- event_date: Event date
- keep_active_until: Optional date that keeps the contract active past its final scheduled payment, so late amendments can still be applied
- charges: Add, update, or remove scheduled charges on a scheduled-charges contract
- modify_in_place: Edit the existing contract and its charges directly instead of cancelling and cloning (only relevant when
chargesis supplied)
Resume restriction: when resuming a cancelled or suspended contract (by setting resume: true or status: ACTIVE), you cannot change amount, frequency, charges, event_date, payment_method, or legal_entities in the same request.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Business Rules
The logic behind this operation, by what the request carries:
- Amend a contract's terms — body carries amount, frequency, occurrences, next_charge or keep_active_until; optional modify-in-place flag
- Amend a scheduled contract's instalments — body carries a charges array of dispositions: id or alt_key only (keep), amount and/or due (amend), deleted (delete), or no reference (new); optional modify_in_place
- Change the payment method on a contract — body carries payment_method (optionally next_payment)
- Move the next charge — body carries next_charge only
- Reschedule the next payment — body carries next_payment only; the literal "now" is accepted
- Resume a contract — suspended contract: body carries status ACTIVE and/or next_charge; cancelled or cancelling contract: body carries resume true with next_charge
- Suspend a contract — body carries status SUSPENDED