[ Web Proxy ]
URL:
Viewing: https://developer.paddle.com/api-reference/subscriptions/resume-subscription [Back]  [Original]
Resume a paused subscription | Paddle Developer Docs

For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling append .md to any URL.

Skip to content
Paddle Docs home
Search Ask AI Toggle Theme svg]:px-3 hidden md:flex" href="https://login.paddle.com/start" data-auth-button="true" data-login-url="https://login.paddle.com/start" data-dashboard-url="https://vendors.paddle.com" data-dashboard-api="https://api.paddle.com/userinfo" data-astro-cid-mq3pp5jd="true"> Login

API reference

Overview
Home
API reference
Subscriptions
svg]:px-2.5 h-8 gap-2 shadow-none md:h-7 md:text-[0.8rem]" href="https://god.gw.postman.com/run-collection/29428794-16aca740-3ad6-4c1a-97be-05dbc504b4c3?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29428794-16aca740-3ad6-4c1a-97be-05dbc504b4c3%26entityType%3Dcollection%26workspaceId%3D5ed2587a-f47e-43e0-810c-0c3e782bca12#?env%5BSandbox%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoiaHR0cHM6Ly9zYW5kYm94LWFwaS5wYWRkbGUuY29tIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQifSx7ImtleSI6ImJlYXJlclRva2VuIiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoic2VjcmV0In1d" target="_blank" rel="noopener noreferrer" title="Fork the Paddle Postman collection" data-postman-run-button="true" data-astro-cid-6ac4p433="true">

Resume a paused subscription

Resumes a paused subscription using its ID.

POST /subscriptions/{subscription_id}/resume

Resumes a paused subscription using its ID. Only paused subscriptions can be resumed. If an active subscription has a scheduled change to pause in the future, use this operation to set or change the resume date.

You can't resume a canceled subscription.

On resume, Paddle bills for a subscription immediately by default. Subscription billing dates are recalculated based on the resume date. Use the on_resume field to change this behavior.

If successful, Paddle returns a copy of the updated subscription entity:

  • When resuming a paused subscription immediately, the subscription status is active, and billing dates are updated to reflect the resume date.
  • When scheduling a paused subscription to resume on a date in the future, the subscription status is paused, and scheduled_change.action is resume with scheduled_change.effective_at set to the scheduled resume date.
  • When changing the resume date for an active subscription that's scheduled to pause, the subscription status remains active, and scheduled_change.resume_at is updated on the existing pause scheduled change.

This operation may result in an immediate charge, so responses may take longer than usual while a payment attempt is processed.

Requires subscription.write permission.

Path parameters

subscription_idstringrequired
Paddle ID of the subscription entity to work with.

Request body

Resume on a specific date
effective_fromstring (date-time)required
Example: 2024-10-12T07:20:50.52Z

When this scheduled change should take effect from. RFC 3339 datetime string of when the subscription should resume.

Valid where subscriptions are active with a scheduled change to pause, or where they have the status of paused.

on_resumestring
Default: start_new_billing_period
How Paddle should set the billing period for the subscription when resuming. If omitted, defaults to start_new_billing_period.
Values
  • continue_existing_billing_period
    When resuming, continue the existing billing period. If the customer resumes before the end date of the existing billing period, there's no immediate charge. If after, an error is returned.
  • start_new_billing_period
    When resuming, start a new billing period. The current_billing_period.starts_at date is set to the resume date, and Paddle immediately charges the full amount for the new billing period.
Resume immediately
effective_fromstring | nullrequired
Default: immediately

When this subscription change should take effect from. You can pass immediately to resume immediately.

Valid where subscriptions have the status of paused.

Defaults to immediately if omitted.

Values
  • immediately
    Takes effect immediately. For automatically-collected subscriptions, responses may take longer than usual while a payment attempt is processed.
on_resumestring
Default: start_new_billing_period
How Paddle should set the billing period for the subscription when resuming. If omitted, defaults to start_new_billing_period.
Values
  • continue_existing_billing_period
    When resuming, continue the existing billing period. If the customer resumes before the end date of the existing billing period, there's no immediate charge. If after, an error is returned.
  • start_new_billing_period
    When resuming, start a new billing period. The current_billing_period.starts_at date is set to the resume date, and Paddle immediately charges the full amount for the new billing period.
nullobject

Response (200)

dataobjectrequired
Represents a subscription entity.
idstringrequired
Example: sub_01h04vsc0qhwtsbsxh3422wjs4
Unique Paddle ID for this subscription entity, prefixed with sub_.
Pattern: ^sub_[a-z\d]{26}$
statusstringrequired
Status of this subscription. Set automatically by Paddle. Use the pause subscription or cancel subscription operations to change.
Values
  • active
    Subscription is active. Paddle is billing for this subscription and related transactions aren't past due.
  • canceled
    Subscription is canceled. Automatically set by Paddle when a subscription is canceled. When a subscription is set to cancel on the next billing period, a scheduled change for the cancellation is created. The subscription status moves to canceled when the scheduled change takes effect.
  • past_due
    Subscription has an overdue payment. Automatically set by Paddle when payment fails for an automatically-collected transaction, or when payment terms have elapsed for a manually-collected transaction (an invoice).
  • paused
    Subscription is paused. Automatically set by Paddle when a subscription is paused. When a subscription is set to pause on the next billing period, a scheduled change for the pause is created. The subscription status moves to paused when the scheduled change takes effect.
  • trialing
    Subscription is in trial.
customer_idstringrequired
Example: ctm_01grnn4zta5a1mf02jjze7y2ys
Paddle ID of the customer that this subscription is for, prefixed with ctm_.
Pattern: ^ctm_[a-z\d]{26}$
address_idstringrequired
Example: add_01gm302t81w94gyjpjpqypkzkf
Paddle ID of the address that this subscription is for, prefixed with add_.
Pattern: ^add_[a-z\d]{26}$
business_idstring | nullrequired
Example: biz_01grrebrzaee2qj2fqqhmcyzaj
Paddle ID of the business that this subscription is for, prefixed with biz_.
Pattern: ^biz_[a-z\d]{26}$
currency_codestringrequired
Supported three-letter ISO 4217 currency code. Transactions for this subscription are created in this currency. Must be USD, EUR, or GBP if collection_mode is manual.
Values
  • USD
    United States Dollar
  • EUR
    Euro
  • GBP
    Pound Sterling
  • JPY
    Japanese Yen
  • AUD
    Australian Dollar
+ Show all values
  • CAD
    Canadian Dollar
  • CHF
    Swiss Franc
  • HKD
    Hong Kong Dollar
  • SGD
    Singapore Dollar
  • SEK
    Swedish Krona
  • ARS
    Argentine Peso
  • BRL
    Brazilian Real
  • CLP
    Chilean Peso
  • CNY
    Chinese Yuan
  • COP
    Colombian Peso
  • CZK
    Czech Koruna
  • DKK
    Danish Krone
  • HUF
    Hungarian Forint
  • ILS
    Israeli Shekel
  • INR
    Indian Rupee
  • KRW
    South Korean Won
  • MXN
    Mexican Peso
  • NOK
    Norwegian Krone
  • NZD
    New Zealand Dollar
  • PEN
    Peruvian Sol
  • PLN
    Polish Zloty
  • RUB
    Russian Ruble
  • THB
    Thai Baht
  • TRY
    Turkish Lira
  • TWD
    New Taiwan Dollar
  • UAH
    Ukrainian Hryvnia
  • VND
    Vietnamese Dong
  • ZAR
    South African Rand
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
started_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this subscription started. This may be different from first_billed_at if the subscription started in trial.
first_billed_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this subscription was first billed. This may be different from started_at if the subscription started in trial.
next_billed_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this subscription is next scheduled to be billed.
paused_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this subscription was paused. Set automatically by Paddle when the pause subscription operation is used. null if not paused.
canceled_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this subscription was canceled. Set automatically by Paddle when the cancel subscription operation is used. null if not canceled.
discountobject | nullrequired
Details of the discount applied to this subscription.
idstringrequired
Example: dsc_01gv5kpg05xp104ek2fmgjwttf
Unique Paddle ID for this discount, prefixed with dsc_.
Pattern: ^dsc_[a-z\d]{26}$
starts_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this discount was first applied. null for canceled subscriptions where a discount was redeemed but never applied to a transaction.
ends_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this discount no longer applies. Where a discount has maximum_recurring_intervals, this is the date of the last billing period where this discount applies. null where a discount recurs forever.
typestringrequired
Whether this discount applies for multiple billing periods.
Values
  • recurring
    Discount applies to multiple billing periods.
  • one-off
    Discount applies to a single billing period only. Returned when a subscription is created in trial with a discount. The discount is removed from the subscription on renewal.
collection_modestringrequired
Default: automatic
How payment is collected for transactions created for this subscription. automatic for checkout, manual for invoices.
Values
  • automatic
    Payment is collected automatically using a checkout initially, then using a payment method on file.
  • manual
    Payment is collected manually. Customers are sent an invoice with payment terms and can make a payment offline or using a checkout. Requires billing_details.
billing_detailsobject | nullrequired
Details for invoicing. Required if collection_mode is manual.
enable_checkoutbooleanrequired
Default: false
Whether the related transaction may be paid using Paddle Checkout. If omitted when creating a transaction, defaults to false.
purchase_order_numberstringrequired
Customer purchase order number. Appears on invoice documents.
Max length: 100
additional_informationstring | nullrequired
Notes or other information to include on this invoice. Appears on invoice documents.
Max length: 1500
payment_termsobjectrequired
How long a customer has to pay this invoice once issued.
intervalstringrequired
Unit of time.
Values
  • day
  • week
  • month
  • year
frequencyintegerrequired
Amount of time.
Min: 1
current_billing_periodobject | nullrequired
Current billing period for this subscription. Set automatically by Paddle based on the billing cycle. null for paused and canceled subscriptions.
starts_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this period starts.
ends_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this period ends.
billing_cycleobjectrequired
How often this subscription renews. Set automatically by Paddle based on the prices on this subscription.
intervalstringrequired
Unit of time.
Values
  • day
  • week
  • month
  • year
frequencyintegerrequired
Amount of time.
Min: 1
scheduled_changeobject | nullrequired
Change that's scheduled to be applied to a subscription. Use the pause subscription, cancel subscription, and resume subscription operations to create scheduled changes. null if no scheduled changes.
actionstringrequired
Kind of change that's scheduled to be applied to this subscription.
Values
  • cancel
    Subscription is scheduled to cancel. Its status changes to canceled on the effective_at date.
  • pause
    Subscription is scheduled to pause. Its status changes to paused on the effective_at date.
  • resume
    Subscription is scheduled to resume. Its status changes to active on the effective_at date.
effective_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this scheduled change takes effect.
resume_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when a paused subscription should resume. Only used for pause scheduled changes.
management_urlsobjectrequired

Customer portal deep links for this subscription.

Authenticated links are only returned when your API key has Customer portal session (Write) permission. For security, the token appended to authenticated links is temporary. You shouldn't store them.

update_payment_methodstring (uri) | nullrequired
Example: https://buyer-portal.paddle.com/subscriptions/sub_01gtewvbsyeqyhtp2vtc2mctq8/update-payment-method?token=
Link to the page for this subscription in the customer portal with the payment method update form pre-opened. Use as part of workflows to let customers update their payment details. null for manually-collected subscriptions.
cancelstring (uri)required
Example: https://buyer-portal.paddle.com/subscriptions/sub_01gtewvbsyeqyhtp2vtc2mctq8/cancel?token=
Link to the page for this subscription in the customer portal with the subscription cancellation form pre-opened. Use as part of cancel subscription workflows.
itemsarrayrequired
List of items on this subscription. Only recurring items are returned.
Items: 1100
statusstringrequired
Status of this subscription item. Set automatically by Paddle.
Values
  • active
    This item is active. It is not in trial and Paddle bills for it.
  • inactive
    This item is not active. Set when the related subscription is paused.
  • trialing
    This item is in trial. Paddle has not billed for it.
quantitynumberrequired
Quantity of this item on the subscription.
Min: 1
recurringbooleanrequired
Whether this is a recurring item. false if one-time.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this item was added to this subscription.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this item was last updated on this subscription.
previously_billed_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this item was last billed.
next_billed_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this item is next scheduled to be billed.
trial_datesobject | nullrequired
Trial dates for this item.
starts_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this period starts.
ends_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this period ends.
priceobjectrequired
Related price entity for this item. This reflects the price entity at the time it was added to the subscription.
idstringrequired
Example: pri_01gsz8z1q1n00f12qt82y31smh
Unique Paddle ID for this price, prefixed with pri_.
Pattern: ^pri_[a-z\d]{26}$
product_idstringrequired
Example: pro_01gsz97mq9pa4fkyy0wqenepkz
Paddle ID for the product that this price is for, prefixed with pro_.
Pattern: ^pro_[a-z\d]{26}$
descriptionstringrequired
Internal description for this price, not shown to customers. Typically notes for your team.
Length: 2500
typestringrequired
Default: standard
Type of item. Standard items are considered part of your catalog and are shown in the Paddle dashboard.
Values
  • custom
    Non-catalog item. Typically created for a specific transaction or subscription. Not returned when listing or shown in the Paddle dashboard.
  • standard
    Standard item. Can be considered part of your catalog and reused across transactions and subscriptions easily.
namestring | nullrequired
Name of this price, shown to customers at checkout and on invoices. Typically describes how often the related product bills.
Length: 1150
billing_cycleobject | nullrequired
How often this price should be charged. null if price is non-recurring (one-time).
intervalstringrequired
Unit of time.
Values
  • day
  • week
  • month
  • year
frequencyintegerrequired
Amount of time.
Min: 1
trial_periodobject | nullrequired
Trial period for the product related to this price. The billing cycle begins once the trial period is over. null for no trial period. Requires billing_cycle.
intervalstringrequired
Unit of time.
Values
  • day
  • week
  • month
  • year
frequencyintegerrequired
Amount of time.
Min: 1
requires_payment_methodbooleanrequired
Default: true
Whether this price requires a payment method (true) or not (false) when trialing. If false, customers can sign up for subscription without entering their payment details, often referred to as a "cardless trial."
unit_priceobject | null
Trial price. Customers are billed this amount for the duration of the trial period. Applies to all customers except those in countries with unit_price_overrides. If null, customers are not charged during the trial.
amountstringrequired
Amount in the lowest denomination for the currency, e.g. 10 USD = 1000 (cents). Although represented as a string, this value must be a valid integer.
currency_codestring
Supported three-letter ISO 4217 currency code.
Values
  • USD
    United States Dollar
  • EUR
    Euro
  • GBP
    Pound Sterling
  • JPY
    Japanese Yen
  • AUD
    Australian Dollar
+ Show all values
  • CAD
    Canadian Dollar
  • CHF
    Swiss Franc
  • HKD
    Hong Kong Dollar
  • SGD
    Singapore Dollar
  • SEK
    Swedish Krona
  • ARS
    Argentine Peso
  • BRL
    Brazilian Real
  • CLP
    Chilean Peso
  • CNY
    Chinese Yuan
  • COP
    Colombian Peso
  • CZK
    Czech Koruna
  • DKK
    Danish Krone
  • HUF
    Hungarian Forint
  • ILS
    Israeli Shekel
  • INR
    Indian Rupee
  • KRW
    South Korean Won
  • MXN
    Mexican Peso
  • NOK
    Norwegian Krone
  • NZD
    New Zealand Dollar
  • PEN
    Peruvian Sol
  • PLN
    Polish Zloty
  • RUB
    Russian Ruble
  • THB
    Thai Baht
  • TRY
    Turkish Lira
  • TWD
    New Taiwan Dollar
  • UAH
    Ukrainian Hryvnia
  • VND
    Vietnamese Dong
  • ZAR
    South African Rand
unit_price_overridesarray
List of unit price overrides for trial pricing. Use to override base trial price with a custom trial price and currency for a country or group of countries.
Items: max 250
country_codesarrayrequired
Supported two-letter ISO 3166-1 alpha-2 country code. Customers located in the listed countries are charged the override price.
Items: min 1, unique
string
Two-letter ISO 3166-1 alpha-2 representation of a supported country.
Values
  • AD
    Andorra
  • AE
    United Arab Emirates
  • AG
    Antigua and Barbuda
  • AI
    Anguilla
  • AL
    Albania
+ Show all values
  • AM
    Armenia
  • AO
    Angola
  • AR
    Argentina
  • AS
    American Samoa
  • AT
    Austria
  • AU
    Australia
  • AW
    Aruba
  • AX
    land Islands
  • AZ
    Azerbaijan
  • BA
    Bosnia and Herzegovina
  • BB
    Barbados
  • BD
    Bangladesh
  • BE
    Belgium
  • BF
    Burkina Faso
  • BG
    Bulgaria
  • BH
    Bahrain
  • BI
    Burundi
  • BJ
    Benin
  • BL
    Saint Barthlemy
  • BM
    Bermuda
  • BN
    Brunei
  • BO
    Bolivia
  • BQ
    Caribbean Netherlands (Bonaire, Sint Eustatius, and Saba)
  • BR
    Brazil
  • BS
    Bahamas
  • BT
    Bhutan
  • BV
    Bouvet Island
  • BW
    Botswana
  • BZ
    Belize
  • CA
    Canada
  • CC
    Cocos Islands
  • CG
    Republic of Congo
  • CH
    Switzerland
  • CI
    Cte d'Ivoire (Ivory Coast)
  • CK
    Cook Islands
  • CL
    Chile
  • CM
    Cameroon
  • CN
    China
  • CO
    Colombia
  • CR
    Costa Rica
  • CV
    Cape Verde
  • CW
    Curaao
  • CX
    Christmas Island
  • CY
    Cyprus
  • CZ
    Czechia (Czech Republic)
  • DE
    Germany
  • DJ
    Djibouti
  • DK
    Denmark
  • DM
    Dominica
  • DO
    Dominican Republic
  • DZ
    Algeria
  • EC
    Ecuador
  • EE
    Estonia
  • EG
    Egypt
  • EH
    Western Sahara
  • ER
    Eritrea
  • ES
    Spain
  • ET
    Ethiopia
  • FI
    Finland
  • FJ
    Fiji
  • FK
    Falkland Islands
  • FM
    Micronesia
  • FO
    Faroe Islands
  • FR
    France
  • GA
    Gabon
  • GB
    United Kingdom
  • GD
    Grenada
  • GE
    Georgia
  • GF
    French Guiana
  • GG
    Guernsey
  • GH
    Ghana
  • GI
    Gibraltar
  • GL
    Greenland
  • GM
    Gambia
  • GN
    Guinea
  • GP
    Guadeloupe
  • GQ
    Equatorial Guinea
  • GR
    Greece
  • GS
    South Georgia and the South Sandwich Islands
  • GT
    Guatemala
  • GU
    Guam
  • GW
    Guinea-Bissau
  • GY
    Guyana
  • HK
    Hong Kong
  • HM
    Heard Island and McDonald Islands
  • HN
    Honduras
  • HR
    Croatia
  • HU
    Hungary
  • ID
    Indonesia
  • IE
    Ireland
  • IL
    Israel
  • IM
    Isle of Man
  • IN
    India
  • IO
    British Indian Ocean Territory
  • IQ
    Iraq
  • IS
    Iceland
  • IT
    Italy
  • JE
    Jersey
  • JM
    Jamaica
  • JO
    Jordan
  • JP
    Japan
  • KE
    Kenya
  • KG
    Kyrgyzstan
  • KH
    Cambodia
  • KI
    Kiribati
  • KM
    Comoros
  • KN
    Saint Kitts and Nevis
  • KR
    South Korea
  • KW
    Kuwait
  • KY
    Cayman Islands
  • KZ
    Kazakhstan
  • LA
    Lao People's Democratic Republic (Laos)
  • LB
    Lebanon
  • LC
    Saint Lucia
  • LI
    Liechtenstein
  • LK
    Sri Lanka
  • LR
    Liberia
  • LS
    Lesotho
  • LT
    Lithuania
  • LU
    Luxembourg
  • LV
    Latvia
  • MA
    Morocco
  • MC
    Monaco
  • MD
    Moldova
  • ME
    Montenegro
  • MF
    Saint Martin
  • MG
    Madagascar
  • MH
    Marshall Islands
  • MK
    Macedonia
  • MN
    Mongolia
  • MO
    Macao
  • MP
    Northern Mariana Islands
  • MQ
    Martinique
  • MR
    Mauritania
  • MS
    Montserrat
  • MT
    Malta
  • MU
    Mauritius
  • MV
    Maldives
  • MW
    Malawi
  • MX
    Mexico
  • MY
    Malaysia
  • MZ
    Mozambique
  • NA
    Namibia
  • NC
    New Caledonia
  • NE
    Niger
  • NF
    Norfolk Island
  • NG
    Nigeria
  • NL
    Netherlands
  • NO
    Norway
  • NP
    Nepal
  • NR
    Nauru
  • NU
    Niue
  • NZ
    New Zealand
  • OM
    Oman
  • PA
    Panama
  • PE
    Peru
  • PF
    French Polynesia
  • PG
    Papua New Guinea
  • PH
    Philippines
  • PK
    Pakistan
  • PL
    Poland
  • PM
    Saint Pierre and Miquelon
  • PN
    Pitcairn
  • PR
    Puerto Rico
  • PS
    Palestinian territories
  • PT
    Portugal
  • PW
    Palau
  • PY
    Paraguay
  • QA
    Qatar
  • RE
    Reunion
  • RO
    Romania
  • RS
    Republic of Serbia
  • RW
    Rwanda
  • SA
    Saudi Arabia
  • SB
    Solomon Islands
  • SC
    Seychelles
  • SE
    Sweden
  • SG
    Singapore
  • SH
    Saint Helena
  • SI
    Slovenia
  • SJ
    Svalbard and Jan Mayen
  • SK
    Slovakia
  • SL
    Sierra Leone
  • SM
    San Marino
  • SN
    Senegal
  • SR
    Suriname
  • ST
    So Tom and Prncipe
  • SV
    El Salvador
  • SX
    Sint Maarten
  • SZ
    Swaziland
  • TC
    Turks and Caicos Islands
  • TD
    Chad
  • TF
    French Southern and Antarctic Lands
  • TG
    Togo
  • TH
    Thailand
  • TJ
    Tajikistan
  • TK
    Tokelau
  • TL
    Timor-Leste
  • TM
    Turkmenistan
  • TN
    Tunisia
  • TO
    Tonga
  • TR
    Turkey
  • TT
    Trinidad and Tobago
  • TV
    Tuvalu
  • TW
    Taiwan
  • TZ
    Tanzania
  • UA
    Ukraine
  • UG
    Uganda
  • UM
    United States Minor Outlying Islands
  • US
    United States
  • UY
    Uruguay
  • UZ
    Uzbekistan
  • VA
    Holy See (Vatican City)
  • VC
    Saint Vincent and the Grenadines
  • VG
    British Virgin Islands
  • VI
    U.S. Virgin Islands
  • VN
    Vietnam
  • VU
    Vanuatu
  • WF
    Wallis and Futuna
  • WS
    Samoa
  • XK
    Kosovo
  • YT
    Mayotte
  • ZA
    South Africa
  • ZM
    Zambia
unit_priceobjectrequired
Override price. This price applies to customers located in the countries for this unit price override.
amountstringrequired
Amount in the lowest denomination for the currency, e.g. 10 USD = 1000 (cents). Although represented as a string, this value must be a valid integer.
currency_codestring
Supported three-letter ISO 4217 currency code.
Values
  • USD
    United States Dollar
  • EUR
    Euro
  • GBP
    Pound Sterling
  • JPY
    Japanese Yen
  • AUD
    Australian Dollar
+ Show all values
  • CAD
    Canadian Dollar
  • CHF
    Swiss Franc
  • HKD
    Hong Kong Dollar
  • SGD
    Singapore Dollar
  • SEK
    Swedish Krona
  • ARS
    Argentine Peso
  • BRL
    Brazilian Real
  • CLP
    Chilean Peso
  • CNY
    Chinese Yuan
  • COP
    Colombian Peso
  • CZK
    Czech Koruna
  • DKK
    Danish Krone
  • HUF
    Hungarian Forint
  • ILS
    Israeli Shekel
  • INR
    Indian Rupee
  • KRW
    South Korean Won
  • MXN
    Mexican Peso
  • NOK
    Norwegian Krone
  • NZD
    New Zealand Dollar
  • PEN
    Peruvian Sol
  • PLN
    Polish Zloty
  • RUB
    Russian Ruble
  • THB
    Thai Baht
  • TRY
    Turkish Lira
  • TWD
    New Taiwan Dollar
  • UAH
    Ukrainian Hryvnia
  • VND
    Vietnamese Dong
  • ZAR
    South African Rand
tax_modestringrequired
Default: account_setting
How tax is calculated for this price.
Values
  • account_setting
    Prices use the setting from your account.
  • external
    Prices are exclusive of tax.
  • internal
    Prices are inclusive of tax.
  • location
    Prices are inclusive or exclusive of tax, depending on the country of the transaction.
unit_priceobjectrequired
Base price. This price applies to all customers, except for customers located in countries where you have unit_price_overrides.
amountstringrequired
Amount in the lowest denomination for the currency, e.g. 10 USD = 1000 (cents). Although represented as a string, this value must be a valid integer.
currency_codestringrequired
Supported three-letter ISO 4217 currency code.
Values
  • USD
    United States Dollar
  • EUR
    Euro
  • GBP
    Pound Sterling
  • JPY
    Japanese Yen
  • AUD
    Australian Dollar
+ Show all values
  • CAD
    Canadian Dollar
  • CHF
    Swiss Franc
  • HKD
    Hong Kong Dollar
  • SGD
    Singapore Dollar
  • SEK
    Swedish Krona
  • ARS
    Argentine Peso
  • BRL
    Brazilian Real
  • CLP
    Chilean Peso
  • CNY
    Chinese Yuan
  • COP
    Colombian Peso
  • CZK
    Czech Koruna
  • DKK
    Danish Krone
  • HUF
    Hungarian Forint
  • ILS
    Israeli Shekel
  • INR
    Indian Rupee
  • KRW
    South Korean Won
  • MXN
    Mexican Peso
  • NOK
    Norwegian Krone
  • NZD
    New Zealand Dollar
  • PEN
    Peruvian Sol
  • PLN
    Polish Zloty
  • RUB
    Russian Ruble
  • THB
    Thai Baht
  • TRY
    Turkish Lira
  • TWD
    New Taiwan Dollar
  • UAH
    Ukrainian Hryvnia
  • VND
    Vietnamese Dong
  • ZAR
    South African Rand
unit_price_overridesarrayrequired
List of unit price overrides. Use to override the base price with a custom price and currency for a country or group of countries.
Items: max 250
country_codesarrayrequired
Supported two-letter ISO 3166-1 alpha-2 country code. Customers located in the listed countries are charged the override price.
Items: min 1, unique
string
Two-letter ISO 3166-1 alpha-2 representation of a supported country.
Values
  • AD
    Andorra
  • AE
    United Arab Emirates
  • AG
    Antigua and Barbuda
  • AI
    Anguilla
  • AL
    Albania
+ Show all values
  • AM
    Armenia
  • AO
    Angola
  • AR
    Argentina
  • AS
    American Samoa
  • AT
    Austria
  • AU
    Australia
  • AW
    Aruba
  • AX
    land Islands
  • AZ
    Azerbaijan
  • BA
    Bosnia and Herzegovina
  • BB
    Barbados
  • BD
    Bangladesh
  • BE
    Belgium
  • BF
    Burkina Faso
  • BG
    Bulgaria
  • BH
    Bahrain
  • BI
    Burundi
  • BJ
    Benin
  • BL
    Saint Barthlemy
  • BM
    Bermuda
  • BN
    Brunei
  • BO
    Bolivia
  • BQ
    Caribbean Netherlands (Bonaire, Sint Eustatius, and Saba)
  • BR
    Brazil
  • BS
    Bahamas
  • BT
    Bhutan
  • BV
    Bouvet Island
  • BW
    Botswana
  • BZ
    Belize
  • CA
    Canada
  • CC
    Cocos Islands
  • CG
    Republic of Congo
  • CH
    Switzerland
  • CI
    Cte d'Ivoire (Ivory Coast)
  • CK
    Cook Islands
  • CL
    Chile
  • CM
    Cameroon
  • CN
    China
  • CO
    Colombia
  • CR
    Costa Rica
  • CV
    Cape Verde
  • CW
    Curaao
  • CX
    Christmas Island
  • CY
    Cyprus
  • CZ
    Czechia (Czech Republic)
  • DE
    Germany
  • DJ
    Djibouti
  • DK
    Denmark
  • DM
    Dominica
  • DO
    Dominican Republic
  • DZ
    Algeria
  • EC
    Ecuador
  • EE
    Estonia
  • EG
    Egypt
  • EH
    Western Sahara
  • ER
    Eritrea
  • ES
    Spain
  • ET
    Ethiopia
  • FI
    Finland
  • FJ
    Fiji
  • FK
    Falkland Islands
  • FM
    Micronesia
  • FO
    Faroe Islands
  • FR
    France
  • GA
    Gabon
  • GB
    United Kingdom
  • GD
    Grenada
  • GE
    Georgia
  • GF
    French Guiana
  • GG
    Guernsey
  • GH
    Ghana
  • GI
    Gibraltar
  • GL
    Greenland
  • GM
    Gambia
  • GN
    Guinea
  • GP
    Guadeloupe
  • GQ
    Equatorial Guinea
  • GR
    Greece
  • GS
    South Georgia and the South Sandwich Islands
  • GT
    Guatemala
  • GU
    Guam
  • GW
    Guinea-Bissau
  • GY
    Guyana
  • HK
    Hong Kong
  • HM
    Heard Island and McDonald Islands
  • HN
    Honduras
  • HR
    Croatia
  • HU
    Hungary
  • ID
    Indonesia
  • IE
    Ireland
  • IL
    Israel
  • IM
    Isle of Man
  • IN
    India
  • IO
    British Indian Ocean Territory
  • IQ
    Iraq
  • IS
    Iceland
  • IT
    Italy
  • JE
    Jersey
  • JM
    Jamaica
  • JO
    Jordan
  • JP
    Japan
  • KE
    Kenya
  • KG
    Kyrgyzstan
  • KH
    Cambodia
  • KI
    Kiribati
  • KM
    Comoros
  • KN
    Saint Kitts and Nevis
  • KR
    South Korea
  • KW
    Kuwait
  • KY
    Cayman Islands
  • KZ
    Kazakhstan
  • LA
    Lao People's Democratic Republic (Laos)
  • LB
    Lebanon
  • LC
    Saint Lucia
  • LI
    Liechtenstein
  • LK
    Sri Lanka
  • LR
    Liberia
  • LS
    Lesotho
  • LT
    Lithuania
  • LU
    Luxembourg
  • LV
    Latvia
  • MA
    Morocco
  • MC
    Monaco
  • MD
    Moldova
  • ME
    Montenegro
  • MF
    Saint Martin
  • MG
    Madagascar
  • MH
    Marshall Islands
  • MK
    Macedonia
  • MN
    Mongolia
  • MO
    Macao
  • MP
    Northern Mariana Islands
  • MQ
    Martinique
  • MR
    Mauritania
  • MS
    Montserrat
  • MT
    Malta
  • MU
    Mauritius
  • MV
    Maldives
  • MW
    Malawi
  • MX
    Mexico
  • MY
    Malaysia
  • MZ
    Mozambique
  • NA
    Namibia
  • NC
    New Caledonia
  • NE
    Niger
  • NF
    Norfolk Island
  • NG
    Nigeria
  • NL
    Netherlands
  • NO
    Norway
  • NP
    Nepal
  • NR
    Nauru
  • NU
    Niue
  • NZ
    New Zealand
  • OM
    Oman
  • PA
    Panama
  • PE
    Peru
  • PF
    French Polynesia
  • PG
    Papua New Guinea
  • PH
    Philippines
  • PK
    Pakistan
  • PL
    Poland
  • PM
    Saint Pierre and Miquelon
  • PN
    Pitcairn
  • PR
    Puerto Rico
  • PS
    Palestinian territories
  • PT
    Portugal
  • PW
    Palau
  • PY
    Paraguay
  • QA
    Qatar
  • RE
    Reunion
  • RO
    Romania
  • RS
    Republic of Serbia
  • RW
    Rwanda
  • SA
    Saudi Arabia
  • SB
    Solomon Islands
  • SC
    Seychelles
  • SE
    Sweden
  • SG
    Singapore
  • SH
    Saint Helena
  • SI
    Slovenia
  • SJ
    Svalbard and Jan Mayen
  • SK
    Slovakia
  • SL
    Sierra Leone
  • SM
    San Marino
  • SN
    Senegal
  • SR
    Suriname
  • ST
    So Tom and Prncipe
  • SV
    El Salvador
  • SX
    Sint Maarten
  • SZ
    Swaziland
  • TC
    Turks and Caicos Islands
  • TD
    Chad
  • TF
    French Southern and Antarctic Lands
  • TG
    Togo
  • TH
    Thailand
  • TJ
    Tajikistan
  • TK
    Tokelau
  • TL
    Timor-Leste
  • TM
    Turkmenistan
  • TN
    Tunisia
  • TO
    Tonga
  • TR
    Turkey
  • TT
    Trinidad and Tobago
  • TV
    Tuvalu
  • TW
    Taiwan
  • TZ
    Tanzania
  • UA
    Ukraine
  • UG
    Uganda
  • UM
    United States Minor Outlying Islands
  • US
    United States
  • UY
    Uruguay
  • UZ
    Uzbekistan
  • VA
    Holy See (Vatican City)
  • VC
    Saint Vincent and the Grenadines
  • VG
    British Virgin Islands
  • VI
    U.S. Virgin Islands
  • VN
    Vietnam
  • VU
    Vanuatu
  • WF
    Wallis and Futuna
  • WS
    Samoa
  • XK
    Kosovo
  • YT
    Mayotte
  • ZA
    South Africa
  • ZM
    Zambia
unit_priceobjectrequired
Override price. This price applies to customers located in the countries for this unit price override.
amountstringrequired
Amount in the lowest denomination for the currency, e.g. 10 USD = 1000 (cents). Although represented as a string, this value must be a valid integer.
currency_codestringrequired
Supported three-letter ISO 4217 currency code.
Values
  • USD
    United States Dollar
  • EUR
    Euro
  • GBP
    Pound Sterling
  • JPY
    Japanese Yen
  • AUD
    Australian Dollar
+ Show all values
  • CAD
    Canadian Dollar
  • CHF
    Swiss Franc
  • HKD
    Hong Kong Dollar
  • SGD
    Singapore Dollar
  • SEK
    Swedish Krona
  • ARS
    Argentine Peso
  • BRL
    Brazilian Real
  • CLP
    Chilean Peso
  • CNY
    Chinese Yuan
  • COP
    Colombian Peso
  • CZK
    Czech Koruna
  • DKK
    Danish Krone
  • HUF
    Hungarian Forint
  • ILS
    Israeli Shekel
  • INR
    Indian Rupee
  • KRW
    South Korean Won
  • MXN
    Mexican Peso
  • NOK
    Norwegian Krone
  • NZD
    New Zealand Dollar
  • PEN
    Peruvian Sol
  • PLN
    Polish Zloty
  • RUB
    Russian Ruble
  • THB
    Thai Baht
  • TRY
    Turkish Lira
  • TWD
    New Taiwan Dollar
  • UAH
    Ukrainian Hryvnia
  • VND
    Vietnamese Dong
  • ZAR
    South African Rand
quantityobjectrequired
Example: {"minimum":1,"maximum":100}
Limits on how many times the related product can be purchased at this price. Useful for discount campaigns.
minimumintegerrequired
Default: 1
Example: 1
Minimum quantity of the product related to this price that can be bought. Required if maximum set.
Range: 1999999999
maximumintegerrequired
Default: 100
Example: 100
Maximum quantity of the product related to this price that can be bought. Required if minimum set. Must be greater than or equal to the minimum value.
Range: 1999999999
statusstringrequired
Default: active
Whether this entity can be used in Paddle.
Values
  • active
    Entity is active and can be used.
  • archived
    Entity is archived, so can't be used.
custom_dataobject | nullrequired
Example: {"customer_reference_id":"abcd1234"}
Your own structured key-value data.
import_metaobject | nullrequired
Import information for this entity. null if this entity is not imported.
external_idstring | null
Example: 9b95b0b8-e10f-441a-862e-1936a6d818ab
Reference or identifier for this entity from the provider where it was imported from.
Length: 1200
imported_fromstringrequired
Example: paddle_classic
Name of the platform or provider where this entity was imported from.
Length: 1200
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
productobjectrequired
Related product entity for this item. This reflects the product entity at the time it was added to the subscription.
idstringrequired
Example: pro_01gsz97mq9pa4fkyy0wqenepkz
Unique Paddle ID for this product, prefixed with pro_.
Pattern: ^pro_[a-z\d]{26}$
namestringrequired
Name of this product.
Length: 1200
descriptionstring | nullrequired
Short description for this product.
Max length: 2048
typestringrequired
Default: standard
Type of item. Standard items are considered part of your catalog and are shown in the Paddle dashboard.
Values
  • custom
    Non-catalog item. Typically created for a specific transaction or subscription. Not returned when listing or shown in the Paddle dashboard.
  • standard
    Standard item. Can be considered part of your catalog and reused across transactions and subscriptions easily.
tax_categorystringrequired
Tax category for this product. Used for charging the correct rate of tax. Selected tax category must be enabled on your Paddle account.
Values
  • digital-goods
    Non-customizable digital files or media (not software) acquired with an up front payment that can be accessed without any physical product being delivered.
  • ebooks
    Digital books and educational material which is sold with permanent rights for use by the customer.
  • implementation-services
    Remote configuration, set-up, and integrating software on behalf of a customer.
  • professional-services
    Services that involve the application of your expertise and specialized knowledge of a software product.
  • saas
    Products that allow users to connect to and use online or cloud-based applications over the Internet.
+ Show all values
  • software-programming-services
    Services that can be used to customize and white label software products.
  • standard
    Software products that are pre-written and can be downloaded and installed onto a local device.
  • training-services
    Training and education services related to software products.
  • website-hosting
    Cloud storage service for personal or corporate information, assets, or intellectual property.
image_urlrequired
Image for this product. Included in the checkout and on some customer documents.
Image Url
A URL to an image.
nullEmpty String
custom_dataobject | nullrequired
Example: {"customer_reference_id":"abcd1234"}
Your own structured key-value data.
statusstringrequired
Default: active
Whether this entity can be used in Paddle.
Values
  • active
    Entity is active and can be used.
  • archived
    Entity is archived, so can't be used.
import_metaobject | nullrequired
Import information for this entity. null if this entity is not imported.
external_idstring | null
Example: 9b95b0b8-e10f-441a-862e-1936a6d818ab
Reference or identifier for this entity from the provider where it was imported from.
Length: 1200
imported_fromstringrequired
Example: paddle_classic
Name of the platform or provider where this entity was imported from.
Length: 1200
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
custom_dataobject | nullrequired
Example: {"customer_reference_id":"abcd1234"}
Your own structured key-value data.
import_metaobject | nullrequired
Import information for this entity. null if this entity is not imported.
external_idstring | null
Example: 9b95b0b8-e10f-441a-862e-1936a6d818ab
Reference or identifier for this entity from the provider where it was imported from.
Length: 1200
imported_fromstringrequired
Example: paddle_classic
Name of the platform or provider where this entity was imported from.
Length: 1200
consent_requirementsarrayrequired
List of active consent requirements for the subscription's current billing period.
idstringrequired
Example: subconreq_01gm302t81w94gyjpjpqypkzkf
Unique Paddle ID for this subscription consent requirement entity, prefixed with subconreq_.
Pattern: ^subconreq_[a-z\d]{26}$
requirementstringrequired
Type of consent required for successful renewal.
Values
  • trial_ending
    Consent required because the trial period is ending.
  • introductory_discount_ending
    Consent required because an initial discount is ending.
statusstringrequired
Status of this consent requirement.
Values
  • pending
    Consent not yet granted. Subscription is canceled on next renewal.
  • granted
    Consent granted. Subscription renews normally.
  • voided
    Consent voided. Consent requirement is no longer applicable, either because the consent is no longer required, or another consent requirement has replaced it.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
consent_periodobject | nullrequired
Period during which consent for this subscription can be granted. null if there is no next_billed_at or the consent requirement does not apply to the current billing period.
starts_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this period starts.
ends_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this period ends.
granted_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when the customer granted their consent. null if not yet granted.
voided_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when consent was voided or no longer required. null if not voided.
metaobjectrequired
Information about this response.
request_idstringrequired
Example: b15ec92e-8688-40d4-a04d-f44cbec93355
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Request Response
Request
{
  "effective_from": "immediately"
}
{ "effective_from": "immediately" }
Response
{
  "data": {
    "id": "sub_01hv959anj4zrw503h2acawb3p",
    "status": "active",
    "customer_id": "ctm_01hv8wt8nffez4p2t6typn4a5j",
    "address_id": "add_01hv958rbhm5n0r6h3tmna4gtv",
    "business_id": null,
    "currency_code": "USD",
    "created_at": "2024-04-12T12:42:27.89Z",
    "updated_at": "2024-04-12T12:44:51.309Z",
    "started_at": "2024-04-12T12:42:27.185672Z",
    "first_billed_at": "2024-04-12T12:42:27.185672Z",
    "next_billed_at": "2024-05-12T12:44:51.27Z",
    "paused_at": null,
    "canceled_at": null,
    "collection_mode": "automatic",
    "billing_details": null,
    "current_billing_period": {
      "starts_at": "2024-04-12T12:44:51.27Z",
      "ends_at": "2024-05-12T12:44:51.27Z"
    },
    "billing_cycle": {
      "frequency": 1,
      "interval": "month"
    },
    "scheduled_change": null,
    "items": [
      {
        "status": "active",
        "quantity": 10,
        "recurring": true,
        "created_at": "2024-04-12T12:42:27.89Z",
        "updated_at": "2024-04-12T12:44:51.311Z",
        "previously_billed_at": "2024-04-12T12:44:51.27Z",
        "next_billed_at": "2024-05-12T12:44:51.27Z",
        "trial_dates": null,
        "price": {
          "id": "pri_01gsz8x8sawmvhz1pv30nge1ke",
          "product_id": "pro_01gsz4t5hdjse780zja8vvr7jg",
          "type": "standard",
          "description": "Monthly",
          "name": "Monthly (per seat)",
          "tax_mode": "account_setting",
          "billing_cycle": {
            "frequency": 1,
            "interval": "month"
          },
          "trial_period": null,
          "unit_price": {
            "amount": "3000",
            "currency_code": "USD"
          },
          "unit_price_overrides": [],
          "custom_data": null,
          "status": "active",
          "quantity": {
            "minimum": 1,
            "maximum": 999
          },
          "import_meta": null,
          "created_at": "2023-02-23T13:55:22.538367Z",
          "updated_at": "2024-04-11T13:54:52.254748Z"
        },
        "product": {
          "id": "pro_01gsz4t5hdjse780zja8vvr7jg",
          "name": "AeroEdit Pro",
          "type": "standard",
          "tax_category": "standard",
          "description": "Designed for professional pilots, including all features plus in Basic plus compliance monitoring, route optimization, and third-party integrations.",
          "image_url": "https://paddle.s3.amazonaws.com/user/165798/bT1XUOJAQhOUxGs83cbk_pro.png",
          "custom_data": {
            "features": {
              "aircraft_performance": true,
              "compliance_monitoring": true,
              "flight_log_management": true,
              "payment_by_invoice": false,
              "route_planning": true,
              "sso": false
            },
            "suggested_addons": [
              "pro_01h1vjes1y163xfj1rh1tkfb65",
              "pro_01gsz97mq9pa4fkyy0wqenepkz"
            ],
            "upgrade_description": "Move from Basic to Pro to take advantage of aircraft performance, advanced route planning, and compliance monitoring."
          },
          "status": "active",
          "import_meta": null,
          "created_at": "2023-02-23T12:43:46.605Z",
          "updated_at": "2024-04-05T15:53:44.687Z"
        }
      },
      {
        "status": "active",
        "quantity": 1,
        "recurring": true,
        "created_at": "2024-04-12T12:42:27.89Z",
        "updated_at": "2024-04-12T12:44:51.312Z",
        "previously_billed_at": "2024-04-12T12:44:51.27Z",
        "next_billed_at": "2024-05-12T12:44:51.27Z",
        "trial_dates": null,
        "price": {
          "id": "pri_01h1vjfevh5etwq3rb416a23h2",
          "product_id": "pro_01h1vjes1y163xfj1rh1tkfb65",
          "type": "standard",
          "description": "Monthly",
          "name": "Monthly (recurring addon)",
          "tax_mode": "account_setting",
          "billing_cycle": {
            "frequency": 1,
            "interval": "month"
          },
          "trial_period": null,
          "unit_price": {
            "amount": "10000",
            "currency_code": "USD"
          },
          "unit_price_overrides": [],
          "custom_data": null,
          "status": "active",
          "quantity": {
            "minimum": 1,
            "maximum": 100
          },
          "import_meta": null,
          "created_at": "2023-06-01T13:31:12.625056Z",
          "updated_at": "2024-04-12T10:42:45.476453Z"
        },
        "product": {
          "id": "pro_01h1vjes1y163xfj1rh1tkfb65",
          "name": "Analytics addon",
          "type": "standard",
          "tax_category": "standard",
          "description": "Unlock advanced insights into your flight data with enhanced analytics and reporting features. Includes customizable reporting templates and trend analysis across flights.",
          "image_url": "https://paddle.s3.amazonaws.com/user/165798/97dRpA6SXzcE6ekK9CAr_analytics.png",
          "custom_data": null,
          "status": "active",
          "import_meta": null,
          "created_at": "2023-06-01T13:30:50.302Z",
          "updated_at": "2024-04-05T15:47:17.163Z"
        }
      }
    ],
    "custom_data": null,
    "management_urls": {
      "update_payment_method": "https://buyer-portal.paddle.com/subscriptions/sub_01hv959anj4zrw503h2acawb3p/update-payment-method",
      "cancel": "https://buyer-portal.paddle.com/subscriptions/sub_01hv959anj4zrw503h2acawb3p/cancel"
    },
    "discount": null,
    "import_meta": null,
    "consent_requirements": []
  },
  "meta": {
    "request_id": "7c010829-486c-4fb6-ac5d-44fbea7723d0"
  }
}
{ "data": { "id": "sub_01hv959anj4zrw503h2acawb3p", "status": "active", "customer_id": "ctm_01hv8wt8nffez4p2t6typn4a5j", "address_id": "add_01hv958rbhm5n0r6h3tmna4gtv", "business_id": null, "currency_code": "USD", "created_at": "2024-04-12T12:42:27.89Z", "updated_at": "2024-04-12T12:44:51.309Z", "started_at": "2024-04-12T12:42:27.185672Z", "first_billed_at": "2024-04-12T12:42:27.185672Z", "next_billed_at": "2024-05-12T12:44:51.27Z", "paused_at": null, "canceled_at": null, "collection_mode": "automatic", "billing_details": null, "current_billing_period": { "starts_at": "2024-04-12T12:44:51.27Z", "ends_at": "2024-05-12T12:44:51.27Z" }, "billing_cycle": { "frequency": 1, "interval": "month" }, "scheduled_change": null, "items": [ { "status": "active", "quantity": 10, "recurring": true, "created_at": "2024-04-12T12:42:27.89Z", "updated_at": "2024-04-12T12:44:51.311Z", "previously_billed_at": "2024-04-12T12:44:51.27Z", "next_billed_at": "2024-05-12T12:44:51.27Z", "trial_dates": null, "price": { "id": "pri_01gsz8x8sawmvhz1pv30nge1ke", "product_id": "pro_01gsz4t5hdjse780zja8vvr7jg", "type": "standard", "description": "Monthly", "name": "Monthly (per seat)", "tax_mode": "account_setting", "billing_cycle": { "frequency": 1, "interval": "month" }, "trial_period": null, "unit_price": { "amount": "3000", "currency_code": "USD" }, "unit_price_overrides": [], "custom_data": null, "status": "active", "quantity": { "minimum": 1, "maximum": 999 }, "import_meta": null, "created_at": "2023-02-23T13:55:22.538367Z", "updated_at": "2024-04-11T13:54:52.254748Z" }, "product": { "id": "pro_01gsz4t5hdjse780zja8vvr7jg", "name": "AeroEdit Pro", "type": "standard", "tax_category": "standard", "description": "Designed for professional pilots, including all features plus in Basic plus compliance monitoring, route optimization, and third-party integrations.", "image_url": "https://paddle.s3.amazonaws.com/user/165798/bT1XUOJAQhOUxGs83cbk_pro.png", "custom_data": { "features": { "aircraft_performance": true, "compliance_monitoring": true, "flight_log_management": true, "payment_by_invoice": false, "route_planning": true, "sso": false }, "suggested_addons": [ "pro_01h1vjes1y163xfj1rh1tkfb65", "pro_01gsz97mq9pa4fkyy0wqenepkz" ], "upgrade_description": "Move from Basic to Pro to take advantage of aircraft performance, advanced route planning, and compliance monitoring." }, "status": "active", "import_meta": null, "created_at": "2023-02-23T12:43:46.605Z", "updated_at": "2024-04-05T15:53:44.687Z" } }, { "status": "active", "quantity": 1, "recurring": true, "created_at": "2024-04-12T12:42:27.89Z", "updated_at": "2024-04-12T12:44:51.312Z", "previously_billed_at": "2024-04-12T12:44:51.27Z", "next_billed_at": "2024-05-12T12:44:51.27Z", "trial_dates": null, "price": { "id": "pri_01h1vjfevh5etwq3rb416a23h2", "product_id": "pro_01h1vjes1y163xfj1rh1tkfb65", "type": "standard", "description": "Monthly", "name": "Monthly (recurring addon)", "tax_mode": "account_setting", "billing_cycle": { "frequency": 1, "interval": "month" }, "trial_period": null, "unit_price": { "amount": "10000", "currency_code": "USD" }, "unit_price_overrides": [], "custom_data": null, "status": "active", "quantity": { "minimum": 1, "maximum": 100 }, "import_meta": null, "created_at": "2023-06-01T13:31:12.625056Z", "updated_at": "2024-04-12T10:42:45.476453Z" }, "product": { "id": "pro_01h1vjes1y163xfj1rh1tkfb65", "name": "Analytics addon", "type": "standard", "tax_category": "standard", "description": "Unlock advanced insights into your flight data with enhanced analytics and reporting features. Includes customizable reporting templates and trend analysis across flights.", "image_url": "https://paddle.s3.amazonaws.com/user/165798/97dRpA6SXzcE6ekK9CAr_analytics.png", "custom_data": null, "status": "active", "import_meta": null, "created_at": "2023-06-01T13:30:50.302Z", "updated_at": "2024-04-05T15:47:17.163Z" } } ], "custom_data": null, "management_urls": { "update_payment_method": "https://buyer-portal.paddle.com/subscriptions/sub_01hv959anj4zrw503h2acawb3p/update-payment-method", "cancel": "https://buyer-portal.paddle.com/subscriptions/sub_01hv959anj4zrw503h2acawb3p/cancel" }, "discount": null, "import_meta": null, "consent_requirements": [] }, "meta": { "request_id": "7c010829-486c-4fb6-ac5d-44fbea7723d0" } }

Was this page helpful?

Yes, helpfulNo, not helpfulI have feedback
Paddle home
Status Security Changelog LLM benchmark Blog Contact
RSS Feed Run in Postman GitHub LinkedIn Twitter YouTube
Privacy policy Terms Manage cookies

Paddle.com Market Ltd. 20122026

Web Proxy Viewer  |  New URL  |  Original Page