preview subscription update
PUT
/payments/preview-paddle-update-subscription
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/payments/preview-paddle-update-subscription' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"paddle_price_id": "pri_01jgkqfbngfg6cg6qcdyem3z4m"
}'Response Response Example
{
"success": true,
"message": "preview update successful",
"data": {
"data": {
"status": "active",
"customer_id": "ctm_01jja0yvygm712sbcy5tg0qm4r",
"address_id": "add_01jjf5czr60rfsdpa1ypr9yysp",
"business_id": null,
"currency_code": "USD",
"created_at": "2025-01-25T16:42:26.654Z",
"updated_at": "2025-01-25T16:51:15.564Z",
"started_at": "2025-01-25T16:42:25.829028Z",
"first_billed_at": "2025-01-25T16:42:25.829028Z",
"next_billed_at": "2025-04-25T16:51:15.482Z",
"paused_at": null,
"canceled_at": null,
"collection_mode": "automatic",
"billing_details": null,
"current_billing_period": {
"starts_at": "2025-01-25T16:51:15.482Z",
"ends_at": "2025-04-25T16:51:15.482Z"
},
"billing_cycle": {
"frequency": 3,
"interval": "month"
},
"recurring_transaction_details": {
"tax_rates_used": [
{
"tax_rate": "0.075",
"totals": {
"subtotal": "7500",
"discount": "0",
"tax": "562",
"total": "8062"
}
}
],
"totals": {
"subtotal": "7500",
"tax": "562",
"discount": "0",
"total": "8062",
"grand_total": "8062",
"fee": null,
"credit": "0",
"credit_to_balance": "0",
"balance": "8062",
"earnings": null,
"currency_code": "USD",
"exchange_rate": "1"
},
"line_items": [
{
"item_id": null,
"price_id": "pri_01jgkqfbngfg6cg6qcdyem3z4m",
"quantity": 1,
"totals": {
"subtotal": "7500",
"tax": "562",
"discount": "0",
"total": "8062"
},
"product": {
"id": "pro_01jghfxvf58s71bzmq2ymqwtve",
"name": "team",
"type": "standard",
"tax_category": "standard",
"description": "",
"image_url": "",
"custom_data": null,
"status": "active",
"created_at": "2025-01-01T17:51:59.973Z",
"updated_at": "2025-01-02T12:40:36.321Z"
},
"tax_rate": "0.075",
"unit_totals": {
"subtotal": "7500",
"discount": "0",
"tax": "562",
"total": "8062"
},
"proration": null
}
]
},
"next_transaction": {
"billing_period": {
"starts_at": "2025-04-25T16:51:15.482Z",
"ends_at": "2025-07-25T16:51:15.482Z"
},
"details": {
"tax_rates_used": [
{
"tax_rate": "0.075",
"totals": {
"subtotal": "7500",
"discount": "0",
"tax": "562",
"total": "8062"
}
}
],
"totals": {
"subtotal": "7500",
"tax": "562",
"discount": "0",
"total": "8062",
"grand_total": "8062",
"fee": null,
"credit": "0",
"credit_to_balance": "0",
"balance": "8062",
"earnings": null,
"currency_code": "USD",
"exchange_rate": "1"
},
"line_items": [
{
"item_id": null,
"price_id": "pri_01jgkqfbngfg6cg6qcdyem3z4m",
"quantity": 1,
"totals": {
"subtotal": "7500",
"tax": "562",
"discount": "0",
"total": "8062"
},
"product": {
"id": "pro_01jghfxvf58s71bzmq2ymqwtve",
"name": "team",
"type": "standard",
"tax_category": "standard",
"description": "",
"image_url": "",
"custom_data": null,
"status": "active",
"created_at": "2025-01-01T17:51:59.973Z",
"updated_at": "2025-01-02T12:40:36.321Z"
},
"tax_rate": "0.075",
"unit_totals": {
"subtotal": "7500",
"discount": "0",
"tax": "562",
"total": "8062"
},
"proration": null
}
]
},
"adjustments": []
},
"immediate_transaction": {
"billing_period": {
"starts_at": "2025-01-25T16:51:15.844Z",
"ends_at": "2025-04-25T16:51:15.482Z"
},
"details": {
"tax_rates_used": [
{
"tax_rate": "0.075",
"totals": {
"subtotal": "6500",
"discount": "0",
"tax": "487",
"total": "6987"
}
}
],
"totals": {
"subtotal": "6500",
"tax": "487",
"discount": "0",
"total": "6987",
"grand_total": "6987",
"fee": null,
"credit": "0",
"credit_to_balance": "0",
"balance": "6987",
"earnings": null,
"currency_code": "USD",
"exchange_rate": "1"
},
"line_items": [
{
"item_id": null,
"price_id": "pri_01jgkqfbngfg6cg6qcdyem3z4m",
"quantity": 1,
"totals": {
"subtotal": "7500",
"tax": "562",
"discount": "0",
"total": "8062"
},
"product": {
"id": "pro_01jghfxvf58s71bzmq2ymqwtve",
"name": "team",
"type": "standard",
"tax_category": "standard",
"description": "",
"image_url": "",
"custom_data": null,
"status": "active",
"created_at": "2025-01-01T17:51:59.973Z",
"updated_at": "2025-01-02T12:40:36.321Z"
},
"tax_rate": "0.075",
"unit_totals": {
"subtotal": "7500",
"discount": "0",
"tax": "562",
"total": "8062"
},
"proration": null
},
{
"item_id": "txnitm_01jjf5d03jhj8h5s9vqd0fy2vp",
"price_id": "pri_01jghfs5cbdpnnssd65k5f8eet",
"quantity": -1,
"totals": {
"subtotal": "-1000",
"tax": "-75",
"discount": "0",
"total": "-1075"
},
"product": {
"id": "pro_01jghfna2trth6n33ycebpprz7",
"name": "pro",
"type": "standard",
"tax_category": "standard",
"description": "",
"image_url": "",
"custom_data": null,
"status": "active",
"created_at": "2025-01-01T17:47:20.026Z",
"updated_at": "2025-01-02T14:43:11.65Z"
},
"tax_rate": "0.075",
"unit_totals": {
"subtotal": "1000",
"discount": "0",
"tax": "75",
"total": "1075"
},
"proration": {
"rate": "0.9998",
"billing_period": {
"starts_at": "2025-01-25T16:51:15.491Z",
"ends_at": "2025-02-25T16:42:25.829028Z"
}
}
}
]
},
"adjustments": []
},
"scheduled_change": null,
"items": [
{
"status": "active",
"quantity": 1,
"recurring": true,
"created_at": "2025-01-25T16:51:15.495Z",
"updated_at": "2025-01-25T16:51:15.495Z",
"previously_billed_at": "2025-01-25T16:51:15.495Z",
"next_billed_at": "2025-04-25T16:51:15.482Z",
"trial_dates": null,
"price": {
"id": "pri_01jgkqfbngfg6cg6qcdyem3z4m",
"product_id": "pro_01jghfxvf58s71bzmq2ymqwtve",
"type": "standard",
"description": "team-quarterly",
"name": "team-quarterly",
"tax_mode": "external",
"billing_cycle": {
"frequency": 3,
"interval": "month"
},
"trial_period": null,
"unit_price": {
"amount": "7500",
"currency_code": "USD"
},
"unit_price_overrides": [],
"custom_data": {
"plan": "team-quarterly"
},
"status": "active",
"quantity": {
"minimum": 1,
"maximum": 999999
},
"import_meta": null,
"created_at": "2025-01-02T14:42:22.512364Z",
"updated_at": "2025-01-23T09:31:27.682503Z"
},
"product": {
"id": "pro_01jghfxvf58s71bzmq2ymqwtve",
"name": "team",
"type": "standard",
"tax_category": "standard",
"description": "",
"image_url": "",
"custom_data": null,
"status": "active",
"created_at": "2025-01-01T17:51:59.973Z",
"updated_at": "2025-01-02T12:40:36.321Z"
}
}
],
"custom_data": null,
"management_urls": {
"update_payment_method": "https://sandbox-buyer-portal.paddle.com/subscriptions/sub_01jjf5fqyyp2ecp16dxk4hhd77/update-payment-method?token=pga_eyJhbGciOiJFZERTQSIsImtpZCI6Imp3a18wMWhkazBuOHF3OG55NTJ5cGNocGNhazA1ayIsInR5cCI6IkpXVCJ9.eyJpZCI6InBnYV8wMWpqZjV6d3Fudm43NGhhejdheGNlbTlzbSIsInNlbGxlci1pZCI6IjI2MDIwIiwidHlwZSI6InN0YW5kYXJkIiwidmVyc2lvbiI6IjEiLCJ1c2FnZSI6Im1hbmFnZW1lbnRfdXJsIiwic2NvcGUiOiJjdXN0b21lci5zdWJzY3JpcHRpb24tcGF5bWVudC51cGRhdGUgY3VzdG9tZXIuc3Vic2NyaXB0aW9uLXBheW1lbnQucmVhZCBjdXN0b21lci5zdWJzY3JpcHRpb24tY2FuY2VsLmNyZWF0ZSBjdXN0b21lci5zdWJzY3JpcHRpb24ucmVhZCIsImlzcyI6Imd1ZXN0YWNjZXNzLXNlcnZpY2UiLCJzdWIiOiJjdG1fMDFqamEweXZ5Z203MTJzYmN5NXRnMHFtNHIiLCJleHAiOjE3NjkzNTk4NzUsImlhdCI6MTczNzgyMzg3NX0.aHf9lP1X713LEgN9ytUtp1Ci4d6bIQG0MauZwZPTfE7dKNU3xkGor6byRZpwWSdK_Ij2RAho_yiFTMaVle76Bw",
"cancel": "https://sandbox-buyer-portal.paddle.com/subscriptions/sub_01jjf5fqyyp2ecp16dxk4hhd77/cancel?token=pga_eyJhbGciOiJFZERTQSIsImtpZCI6Imp3a18wMWhkazBuOHF3OG55NTJ5cGNocGNhazA1ayIsInR5cCI6IkpXVCJ9.eyJpZCI6InBnYV8wMWpqZjV6d3Fudm43NGhhejdheGNlbTlzbSIsInNlbGxlci1pZCI6IjI2MDIwIiwidHlwZSI6InN0YW5kYXJkIiwidmVyc2lvbiI6IjEiLCJ1c2FnZSI6Im1hbmFnZW1lbnRfdXJsIiwic2NvcGUiOiJjdXN0b21lci5zdWJzY3JpcHRpb24tcGF5bWVudC51cGRhdGUgY3VzdG9tZXIuc3Vic2NyaXB0aW9uLXBheW1lbnQucmVhZCBjdXN0b21lci5zdWJzY3JpcHRpb24tY2FuY2VsLmNyZWF0ZSBjdXN0b21lci5zdWJzY3JpcHRpb24ucmVhZCIsImlzcyI6Imd1ZXN0YWNjZXNzLXNlcnZpY2UiLCJzdWIiOiJjdG1fMDFqamEweXZ5Z203MTJzYmN5NXRnMHFtNHIiLCJleHAiOjE3NjkzNTk4NzUsImlhdCI6MTczNzgyMzg3NX0.aHf9lP1X713LEgN9ytUtp1Ci4d6bIQG0MauZwZPTfE7dKNU3xkGor6byRZpwWSdK_Ij2RAho_yiFTMaVle76Bw"
},
"discount": null,
"update_summary": {
"credit": {
"amount": "-1075",
"currency_code": "USD"
},
"charge": {
"amount": "8062",
"currency_code": "USD"
},
"result": {
"action": "charge",
"amount": "6987",
"currency_code": "USD"
}
},
"import_meta": null
},
"meta": {
"request_id": "df3ce3d4-f050-4ce5-935c-4be3623a6afb"
}
}
}Modified at 2025-09-02 07:34:45