This guide will help you integrate the Dodo Payments Subscription Product into your website.
payment_link = true
to get payment link payment_link
.
subscription.active
- Subscription is successfully activated.subscription.on_hold
- Subscription is put on hold due to failed renewal.subscription.failed
- Subscription creation failed during mandate creation.subscription.renewed
- Subscription is renewed for the next billing period.subscription.active
- Indicates subscription activationpayment.succeeded
- Confirms the initial payment:
subscription.renewed
- Indicates payment deduction and renewal for next cycle. (Basically, whenever payment gets deducted for subscription products, you will get subscription.renewed
webhook along with payment.succeeded
)subscription.failed
- Subscription creation failed due to failure to create a mandate.payment.failed
- Indicates failed payment.Property | Type | Required | Description |
---|---|---|---|
business_id | string | Yes | The unique identifier for the business |
timestamp | string | Yes | The timestamp of when the event occurred (not necessarily the same as when it was delivered) |
type | string | Yes | The type of event. See Event Types |
data | object | Yes | The main data payload. See Data Object |
prorated_immediately
full_immediately
difference_immediately
prorated_immediately
, credits will be automatically calculated and added to the subscription’s credit balance. These credits are specific to that subscription and will only be used to offset future recurring payments of the same subscriptionfull_immediately
option bypasses credit calculations and charges the complete new plan amountprorated_immediately
for fair billing that accounts for unused time, or full_immediately
when you want to charge the complete new plan amount regardless of the current billing cycle.on_demand
field in your request body. This allows you to authorize a payment method without an immediate charge, or set a custom initial price.
To charge an on-demand subscription:
For subsequent charges, use the POST /subscriptions/charge endpoint and specify the amount to charge the customer for that transaction.