Retry Subscription
Retries collecting the balance due on a past-due subscription without waiting for the next scheduled attempt.
3D Secure (3DS) Authentication post-authentication flow
When a payment requires 3DS Authentication to adhere to Strong Customer Authentication (SCA), the request enters a post-authentication flow where a 422 Unprocessable Entity status is returned with an action_link that will direct the customer through 3DS Authentication.
See the 3D Secure Post-Authentication Flow article in the product documentation to learn how to manage the redirect flow.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The Chargify id of the subscription.
Response Body
application/json
application/json
curl -X PUT "https://example.com/subscriptions/0/retry.json"{ "subscription": { "id": 46330, "state": "active", "trial_started_at": null, "trial_ended_at": null, "activated_at": "2018-10-22T13:10:46-06:00", "created_at": "2018-10-22T13:10:46-06:00", "updated_at": "2021-06-10T09:23:43-06:00", "expires_at": null, "balance_in_cents": 18600, "current_period_ends_at": "2021-06-22T13:10:46-06:00", "next_assessment_at": "2021-06-22T13:10:46-06:00", "canceled_at": null, "cancellation_message": null, "next_product_id": null, "cancel_at_end_of_period": null, "payment_collection_method": "automatic", "snap_day": null, "cancellation_method": null, "product_price_point_id": 3464, "next_product_price_point_id": null, "receives_invoice_emails": null, "net_terms": null, "locale": null, "currency": "USD", "reference": null, "scheduled_cancellation_at": null, "current_period_started_at": "2021-05-22T13:10:46-06:00", "previous_state": "past_due", "signup_payment_id": 651268, "signup_revenue": "6.00", "delayed_cancel_at": null, "coupon_code": null, "total_revenue_in_cents": 600, "product_price_in_cents": 600, "product_version_number": 501, "payment_type": null, "referral_code": "rzqvrx", "coupon_use_count": null, "coupon_uses_allowed": null, "reason_code": null, "automatically_resume_at": null, "offer_id": null, "credit_balance_in_cents": 0, "prepayment_balance_in_cents": 0, "payer_id": 142365, "stored_credential_transaction_id": null, "next_product_handle": null, "on_hold_at": null, "prepaid_dunning": false, "customer": { "id": 142365, "first_name": "Lavern", "last_name": "Fahey", "organization": null, "email": "millie2@example.com", "created_at": "2018-10-22T13:10:46-06:00", "updated_at": "2018-10-22T13:10:46-06:00", "reference": null, "address": null, "address_2": null, "city": null, "state": null, "zip": null, "country": null, "phone": null, "portal_invite_last_sent_at": null, "portal_invite_last_accepted_at": null, "verified": false, "portal_customer_created_at": "2018-10-22T13:10:46-06:00", "vat_number": null, "cc_emails": "john@example.com, sue@example.com", "tax_exempt": false, "parent_id": null, "locale": null }, "product": { "id": 8080, "name": "Pro Versions", "handle": null, "description": "", "accounting_code": "", "request_credit_card": true, "expiration_interval": null, "expiration_interval_unit": "month", "created_at": "2019-02-15T10:15:00-07:00", "updated_at": "2019-02-15T10:30:34-07:00", "price_in_cents": 600, "interval": 1, "interval_unit": "month", "initial_charge_in_cents": null, "trial_price_in_cents": null, "trial_interval": null, "trial_interval_unit": "month", "archived_at": null, "require_credit_card": true, "return_params": "", "require_shipping_address": false, "request_billing_address": false, "require_billing_address": false, "taxable": false, "update_return_url": "", "tax_code": "", "initial_charge_after_trial": false, "default_product_price_point_id": 3464, "version_number": 501, "update_return_params": "", "product_price_point_id": 3464, "product_price_point_name": "Default", "product_price_point_handle": "uuid:5305c3f0-1375-0137-5619-065dfbfdc636", "product_family": { "id": 37, "name": "Acme Projects", "description": null, "handle": "acme-projects", "accounting_code": null, "created_at": "2013-02-20T15:05:51-07:00", "updated_at": "2013-02-20T15:05:51-07:00" }, "public_signup_pages": [ { "id": 1540, "return_url": null, "return_params": "", "url": "https://acme-test.staging-chargifypay.com/subscribe/2f6y53rrqgsf" } ] } }}Read Sales Rep GET
Returns a sales rep and attached subscription details. ## Modified Authentication Process The Sales Commission API differs from other Chargify API endpoints. This resource is associated with the seller itself. Up to now all available resources were at the level of the site, therefore creating the API Key per site was a sufficient solution. To share resources at the seller level, a new authentication method was introduced, which is user authentication. Creating an API Key for a user is a required step to correctly use the Sales Commission API, more details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication). Access to the Sales Commission API endpoints is available to users with financial access, where the seller has the Advanced Analytics component enabled. For further information on getting access to Advanced Analytics contact Maxio support. > Note: The request is at seller level, it means `<<subdomain>>` variable will be replaced by `app`.
Cancel Subscription DELETE
Cancels the Subscription. The Delete method sets the Subscription state to `canceled`. To cancel the subscription immediately, omit any schedule parameters from the request. To use the schedule options, the Schedule Subscription Cancellation feature must be enabled on your site.