Dodo Payments

App · 20 actions

Create checkout sessions and manage customers, payments, subscriptions, and refunds.

Actions

ActionWhat it does
Create checkoutCreate checkout in Dodo Payments.
Create customerCreate customer in Dodo Payments.
Create customer portal sessionCreate customer portal session in Dodo Payments.
Create refundCreate refund in Dodo Payments.
Get checkoutRetrieve checkout from Dodo Payments.
Get customerRetrieve customer from Dodo Payments.
Get paymentRetrieve payment from Dodo Payments.
Get productRetrieve product from Dodo Payments.
Get refundRetrieve refund from Dodo Payments.
Get subscriptionRetrieve subscription from Dodo Payments.
List customer payment methodsRetrieve a page of customer payment methods from Dodo Payments.
List customersRetrieve a page of customers from Dodo Payments.
List payment line itemsRetrieve a page of payment line items from Dodo Payments.
List paymentsRetrieve a page of payments from Dodo Payments.
List productsRetrieve a page of products from Dodo Payments.
List refundsRetrieve a page of refunds from Dodo Payments.
List subscriptionsRetrieve a page of subscriptions from Dodo Payments.
List webhooksRetrieve a page of webhooks from Dodo Payments.
Update customerUpdate customer in Dodo Payments.
Update subscriptionUpdate subscription in Dodo Payments.

Create checkout

Create checkout in Dodo Payments.

Inputs

Billing addressbilling_addressobject
Billing address information for the session.
Cancel URLcancel_urltext
The URL to redirect the customer if they cancel or go back from the checkout.
Customercustomertext
Customer details for the session.
Discount codediscount_codetext
DEPRECATED: Use discount_codes instead. Cannot be used together with discount_codes.
Metadatametadataobject
Additional metadata associated with the payment. Defaults to empty if not provided.
Product cartproduct_cartlistRequired
The products of the checkout. A cart holds at most 20 of them, one-time and.
Return URLreturn_urltext
The url to redirect after payment failure or success.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "checkout_url": "example",
    "client_secret": "example",
    "payment_id": "example",
    "publishable_key": "example",
    "session_id": "example"
  }
}

Create customer

Create customer in Dodo Payments.

Inputs

EmailemailtextRequired
Email.
Metadatametadataobject
Additional metadata for the customer.
NamenametextRequired
Name.
Phone numberphone_numbertext
Phone number.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "blocked_at": "example",
    "blocklist_entry_id": "example",
    "business_id": "example",
    "created_at": "example",
    "customer_id": "example",
    "email": "example",
    "metadata": {},
    "name": "example",
    "phone_number": "example"
  }
}

Create customer portal session

Create customer portal session in Dodo Payments.

Inputs

Send emailsend_emailtrue/false
If true, will send link to user.
Return URLreturn_urltext
Optional return URL for this session. Overrides the business-level default.
Customercustomer_idtextRequired
Customer Id.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "link": "example"
  }
}

Create refund

Create refund in Dodo Payments.

Inputs

Currencycurrencytext
The currency of every `items[].amount`. It must be the currency the customer paid in.One of: AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, and 135 more.
Itemsitemslist
Partially Refund an Individual Item.
Metadatametadataobject
Additional metadata associated with the refund.
Paymentpayment_idtextRequired
The unique identifier of the payment to be refunded.
Reasonreasontext
The reason for the refund, if any. Maximum length is 3000 characters. Optional.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "amount": 1,
    "brand_id": "example",
    "business_id": "example",
    "created_at": "example",
    "currency": null,
    "customer": {
      "customer_id": "example",
      "email": "example",
      "metadata": {},
      "name": "example",
      "phone_number": "example"
    },
    "is_partial": false,
    "metadata": {},
    "network_reference": "example",
    "network_reference_type": null,
    "network_reference_updated_at": "example",
    "payment_id": "example",
    "reason": "example",
    "refund_id": "example",
    "status": "succeeded"
  }
}

Get checkout

Retrieve checkout from Dodo Payments.

Inputs

Checkout IDcheckout_idtextRequired
Checkout Session ID.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "created_at": "example",
    "customer_email": "example",
    "customer_name": "example",
    "id": "example",
    "payment_id": "example",
    "payment_status": null
  }
}

Get customer

Retrieve customer from Dodo Payments.

Inputs

Customercustomer_idtextRequired
Customer Id.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "blocked_at": "example",
    "blocklist_entry_id": "example",
    "business_id": "example",
    "created_at": "example",
    "customer_id": "example",
    "email": "example",
    "metadata": {},
    "name": "example",
    "phone_number": "example"
  }
}

Get payment

Retrieve payment from Dodo Payments.

Inputs

Paymentpayment_idtextRequired
Payment Id.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "billing": {
      "city": "example",
      "country": "AF",
      "state": "example",
      "street": "example",
      "zipcode": "example"
    },
    "brand_id": "example",
    "business_id": "example",
    "card_exp_month": "example",
    "card_exp_year": "example",
    "card_holder_name": "example",
    "card_issuing_country": null,
    "card_last_four": "example",
    "card_network": "example",
    "card_type": "example",
    "charge_type": null,
    "checkout_session_id": "example",
    "created_at": "example",
    "currency": "AED",
    "custom_field_responses": [],
    "customer": {
      "customer_id": "example",
      "email": "example",
      "metadata": {},
      "name": "example",
      "phone_number": "example"
    },
    "digital_products_delivered": false,
    "discount_id": "example",
    "discounts": [],
    "disputes": [],
    "error_code": "example",
    "error_message": "example",
    "includes_usage": false,
    "invoice_id": "example",
    "invoice_url": "example",
    "is_multi_subscription": false,
    "is_update_payment_method": false,
    "metadata": {},
    "payment_id": "example",
    "payment_link": "example",
    "payment_method": "example",
    "payment_method_id": "example",
    "payment_method_type": "example",
    "payment_provider": "stripe",
    "product_cart": [],
    "refund_status": null,
    "refunds": [],
    "retry_attempt": 1,
    "service_periods": [],
    "settlement_amount": 1,
    "settlement_currency": "AED",
    "settlement_tax": 1,
    "status": null,
    "subscription_id": "example",
    "subscription_ids": [],
    "tax": 1,
    "three_ds_flow": null,
    "three_ds_status": null,
    "three_ds_version": "example",
    "total_amount": 1,
    "updated_at": "example"
  }
}

Get product

Retrieve product from Dodo Payments.

Inputs

Productproduct_idtextRequired
Product Id.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "addons": [],
    "brand_id": "example",
    "business_id": "example",
    "created_at": "example",
    "credit_entitlements": [],
    "description": "example",
    "digital_product_delivery": null,
    "entitlements": [],
    "image": "example",
    "is_recurring": false,
    "license_key_activation_message": "example",
    "license_key_activations_limit": 1,
    "license_key_duration": null,
    "license_key_enabled": false,
    "metadata": {},
    "name": "example",
    "price": "example",
    "pricing_mode": null,
    "product_collection_id": "example",
    "product_id": "example",
    "tax_category": "digital_products",
    "updated_at": "example"
  }
}

Get refund

Retrieve refund from Dodo Payments.

Inputs

Refundrefund_idtextRequired
Refund Id.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "amount": 1,
    "brand_id": "example",
    "business_id": "example",
    "created_at": "example",
    "currency": null,
    "customer": {
      "customer_id": "example",
      "email": "example",
      "metadata": {},
      "name": "example",
      "phone_number": "example"
    },
    "is_partial": false,
    "metadata": {},
    "network_reference": "example",
    "network_reference_type": null,
    "network_reference_updated_at": "example",
    "payment_id": "example",
    "reason": "example",
    "refund_id": "example",
    "status": "succeeded"
  }
}

Get subscription

Retrieve subscription from Dodo Payments.

Inputs

Subscriptionsubscription_idtextRequired
Subscription Id.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "addons": [],
    "billing": {
      "city": "example",
      "country": "AF",
      "state": "example",
      "street": "example",
      "zipcode": "example"
    },
    "billing_mode": "normal",
    "brand_id": "example",
    "cancel_at_next_billing_date": false,
    "cancellation_comment": "example",
    "cancellation_feedback": null,
    "cancelled_at": "example",
    "cancelled_by": null,
    "collection_method": null,
    "created_at": "example",
    "credit_entitlement_cart": [],
    "currency": "AED",
    "custom_field_responses": [],
    "customer": {
      "customer_id": "example",
      "email": "example",
      "metadata": {},
      "name": "example",
      "phone_number": "example"
    },
    "customer_business_name": "example",
    "discount_cycles_remaining": 1,
    "discount_id": "example",
    "discounts": [],
    "expires_at": "example",
    "has_payment_method": false,
    "metadata": {},
    "meter_credit_entitlement_cart": [],
    "meters": [],
    "next_billing_date": "example",
    "on_demand": false,
    "paused_at": "example",
    "payment_frequency_count": 1,
    "payment_frequency_interval": "Day",
    "payment_method_id": "example",
    "payment_terms_days": 1,
    "previous_billing_date": "example",
    "product_id": "example",
    "quantity": 1,
    "recurring_pre_tax_amount": 1,
    "scheduled_change": null,
    "status": "pending",
    "subscription_id": "example",
    "subscription_period_count": 1,
    "subscription_period_interval": "Day",
    "tax_id": "example",
    "tax_inclusive": false,
    "trial_amount": 1,
    "trial_period_days": 1
  }
}

List customer payment methods

Retrieve a page of customer payment methods from Dodo Payments.

Inputs

Customercustomer_idtextRequired
Customer Id.
Currencycurrencytext
Currency.One of: AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, and 135 more.
Billing countrybilling_countrytext
Billing country.One of: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, and 239 more.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "items": []
  }
}

List customers

Retrieve a page of customers from Dodo Payments.

Inputs

Page sizepage_sizenumber
Page size default is 10 max is 100.At least 0.
Page numberpage_numbernumber
Page number default is 0.At least 0.
Emailemailtext
Filter by customer email.
Namenametext
Filter by customer name (partial match, case-insensitive).
Created at gtecreated_at_gtedate and time
Filter customers created on or after this timestamp.
Created at ltecreated_at_ltedate and time
Filter customers created on or before this timestamp.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "items": []
  }
}

List payment line items

Retrieve a page of payment line items from Dodo Payments.

Inputs

Paymentpayment_idtextRequired
Payment Id.
Currencycurrencytext
The currency of the amounts. It must be the currency that the customer paid in. Without.One of: AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, and 135 more.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "currency": "AED",
    "items": [],
    "partial_refund_allowed": false
  }
}

List payments

Retrieve a page of payments from Dodo Payments.

Inputs

Created at gtecreated_at_gtedate and time
Get events after this created time.
Created at ltecreated_at_ltedate and time
Get events created before this time.
Page sizepage_sizenumber
Page size default is 10 max is 100.At least 0.
Page numberpage_numbernumber
Page number default is 0. Capped to bound OFFSET-based deep pagination,.At least 0.
Customercustomer_idtext
Filter by customer id.
Subscriptionsubscription_idtext
Filter by subscription id.
Statusstatustext
Filter by status.One of: succeeded, failed, cancelled, processing, requires_customer_action (Requires customer action), requires_merchant_action (Requires merchant action), requires_payment_method (Requires payment method), requires_confirmation (Requires confirmation), requires_capture (Requires capture), partially_captured (Partially captured), partially_captured_and_capturable (Partially captured and capturable).
Brand IDbrand_idtext
filter by Brand id.
Productproduct_idtext
Filter by product id.
Currencycurrencytext
Filter by currency.One of: AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, and 135 more.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "items": []
  }
}

List products

Retrieve a page of products from Dodo Payments.

Inputs

Page sizepage_sizenumber
Page size default is 10 max is 100.At least 0.
Page numberpage_numbernumber
Page number default is 0.At least 0.
Archivedarchivedtrue/false
List archived products.
Recurringrecurringtrue/false
Filter products by pricing type:.
Brand IDbrand_idtext
filter by Brand id.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "items": []
  }
}

List refunds

Retrieve a page of refunds from Dodo Payments.

Inputs

Created at gtecreated_at_gtedate and time
Get events after this created time.
Created at ltecreated_at_ltedate and time
Get events created before this time.
Page sizepage_sizenumber
Page size default is 10 max is 100.At least 0.
Page numberpage_numbernumber
Page number default is 0.At least 0.
Statusstatustext
Filter by status.One of: succeeded, failed, pending, review.
Subscriptionsubscription_idtext
Filter by subscription id.
Customercustomer_idtext
Filter by customer_id.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "items": []
  }
}

List subscriptions

Retrieve a page of subscriptions from Dodo Payments.

Inputs

Created at gtecreated_at_gtedate and time
Get events after this created time.
Created at ltecreated_at_ltedate and time
Get events created before this time.
Page sizepage_sizenumber
Page size default is 10 max is 100.At least 0.
Page numberpage_numbernumber
Page number default is 0.At least 0.
Customercustomer_idtext
Filter by customer id.
Statusstatustext
Filter by status.One of: pending, active, on_hold (On hold), paused, cancelled, failed, expired, past_due (Past due).
Brand IDbrand_idtext
filter by Brand id.
Productproduct_idtext
Filter by product id.
Cancel at next billing datecancel_at_next_billing_datetrue/false
Filter by cancel_at_next_billing_date (subscriptions scheduled for cancellation).

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "items": []
  }
}

List webhooks

Retrieve a page of webhooks from Dodo Payments.

Inputs

Limitlimitnumber
Limit the number of returned items.
Iteratoriteratortext
The iterator returned from a prior invocation.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "data": [],
    "done": false,
    "iterator": "example",
    "prev_iterator": "example"
  }
}

Update customer

Update customer in Dodo Payments.

Inputs

Customercustomer_idtextRequired
Customer Id.
Emailemailtext
Email.
Metadatametadataobject
Additional metadata for the customer.
Namenametext
Name.
Phone numberphone_numbertext
Phone number.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "blocked_at": "example",
    "blocklist_entry_id": "example",
    "business_id": "example",
    "created_at": "example",
    "customer_id": "example",
    "email": "example",
    "metadata": {},
    "name": "example",
    "phone_number": "example"
  }
}

Update subscription

Update subscription in Dodo Payments.

Inputs

Subscriptionsubscription_idtextRequired
Subscription Id.
Billingbillingobject
Billing.
Cancel at next billing datecancel_at_next_billing_datetrue/false
When set, the subscription will remain active until the end of billing period.
Cancel reasoncancel_reasontext
Cancel reason.One of: cancelled_by_customer (Cancelled by customer), cancelled_by_merchant (Cancelled by merchant), cancelled_by_merchant_send_dunning (Cancelled by merchant send dunning), cancelled_by_merchant_grace_period_expired (Cancelled by merchant grace period expired), dodo_team (Dodo team).
Cancellation commentcancellation_commenttext
Free-text cancellation comment (only valid when cancelling or scheduling cancellation).
Cancellation feedbackcancellation_feedbacktext
Customer-supplied churn reason (only valid when cancelling or scheduling cancellation).One of: too_expensive (Too expensive), missing_features (Missing features), switched_service (Switched service), unused, customer_service (Customer service), low_quality (Low quality), too_complex (Too complex), other.
Credit entitlement cartcredit_entitlement_cartlist
Update credit entitlement cart settings.
Customer business namecustomer_business_nametext
Optional business / legal name associated with the tax id. When provided.
Customer namecustomer_nametext
Customer name.
Disable on demanddisable_on_demandobject
Disable on demand.
Metadatametadataobject
Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
Next billing datenext_billing_datedate and time
Next billing date.
Pausepausetrue/false
Removed. Use `status: paused` to pause and `status: active` to resume.
Statusstatustext
Set to `cancelled` to cancel the subscription. See `cancel_reason`,.One of: pending, active, on_hold (On hold), paused, cancelled, failed, expired, past_due (Past due).
Subscription period countsubscription_period_countnumber
New number of `subscription_period_interval` units the subscription.
Subscription period intervalsubscription_period_intervaltext
New interval unit for the subscription period. When changing the period,.One of: Day, Week, Month, Year.
Tax IDtax_idtext
Tax id.

Outputs

dataobject
The result returned by Dodo Payments.
Example output
{
  "data": {
    "addons": [],
    "billing": {
      "city": "example",
      "country": "AF",
      "state": "example",
      "street": "example",
      "zipcode": "example"
    },
    "billing_mode": "normal",
    "brand_id": "example",
    "cancel_at_next_billing_date": false,
    "cancellation_comment": "example",
    "cancellation_feedback": null,
    "cancelled_at": "example",
    "cancelled_by": null,
    "collection_method": null,
    "created_at": "example",
    "credit_entitlement_cart": [],
    "currency": "AED",
    "custom_field_responses": [],
    "customer": {
      "customer_id": "example",
      "email": "example",
      "metadata": {},
      "name": "example",
      "phone_number": "example"
    },
    "customer_business_name": "example",
    "discount_cycles_remaining": 1,
    "discount_id": "example",
    "discounts": [],
    "expires_at": "example",
    "has_payment_method": false,
    "metadata": {},
    "meter_credit_entitlement_cart": [],
    "meters": [],
    "next_billing_date": "example",
    "on_demand": false,
    "paused_at": "example",
    "payment_frequency_count": 1,
    "payment_frequency_interval": "Day",
    "payment_method_id": "example",
    "payment_terms_days": 1,
    "previous_billing_date": "example",
    "product_id": "example",
    "quantity": 1,
    "recurring_pre_tax_amount": 1,
    "scheduled_change": null,
    "status": "pending",
    "subscription_id": "example",
    "subscription_period_count": 1,
    "subscription_period_interval": "Day",
    "tax_id": "example",
    "tax_inclusive": false,
    "trial_amount": 1,
    "trial_period_days": 1
  }
}

On this page