| [ Web Proxy ] |
| Viewing: https://developer.paddle.com/api-reference/transactions/create-transaction | [Back] [Original] |
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.
Creates a new transaction.
/transactions Creates a new transaction.
Transactions are typically created with the status of draft or ready initially:
items against them, but don't have all of the required fields for billing. Paddle creates draft transactions automatically when a checkout is opened.ready when all of the required fields are present for billing. This includes customer_id and address_id for automatically-collected transactions, and billing_details for manually-collected transactions.The collection_mode against a transaction determines how Paddle tries to collect for payment:
billed. Payment is often by wire transfer.checkout.url to collect for payment.When a manually-collected transaction is marked as billed or an automatically-collected transaction is completed, Paddle automatically creates a related subscription for the items on the transaction.
If successful, your response includes a copy of the new transaction entity.
Use the include parameter to include related entities in the response.
transaction.write
permission.
addressaddress_id is set against the transaction.adjustmentsadjustments_totalsavailable_payment_methodsbusinessbusiness_id is set against the transaction.customercustomer_id is set against the transaction.discountdiscount_id is set against the transaction.Status of this transaction. You may set a transaction to billed when creating,
or omit to let Paddle set the status. Transactions are created as ready if they have
an address_id, customer_id, and items, otherwise they are created as draft.
Marking as billed when creating is typically used when working with manually-collected
transactions as part of an invoicing workflow. Billed transactions cannot be updated, only canceled.
draftreadybilled or completed.billedbilled. Billed transactions get an invoice number and are considered a legal record. They cannot be changed. Typically used as part of an invoice workflow.paidcompletedcanceledcanceled. If an invoice, it's no longer due.past_duectm_01grnn4zta5a1mf02jjze7y2ysctm_. If omitted, transaction status is draft.^ctm_[a-z\d]{26}$add_01gm302t81w94gyjpjpqypkzkfadd_. Requires customer_id. If omitted, transaction status is draft.^add_[a-z\d]{26}$biz_01grrebrzaee2qj2fqqhmcyzajbiz_. Requires customer_id. ^biz_[a-z\d]{26}${"customer_reference_id":"abcd1234"}USD, EUR, or GBP if collection_mode is manual.USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARautomaticautomatic for checkout, manual for invoices. If omitted, defaults to automatic.automaticmanualbilling_details.dsc_01gv5kpg05xp104ek2fmgjwttfdsc_.^dsc_[a-z\d]{26}$discount_id or discount.flatcurrency_code.flat_per_seatcurrency_code.percentagepercentage discounts, must be an amount between 0.01 and 100. For flat and flat_per_seat discounts, amount in the lowest denomination for a currency.falsetrue) or not (false). If omitted, defaults to false.Number of subscription billing periods that this discount recurs for. Requires recur. null if this discount recurs forever.
Subscription renewals, midcycle changes, and one-time charges billed to a subscription aren't considered a redemption. times_used is not incremented in these cases.
{"customer_reference_id":"abcd1234"}null if this discount applies to all products and prices.collection_mode is manual.falsefalse.dayweekmonthyear2024-10-12T07:20:50.52Z2024-10-12T07:20:50.52ZList of items to charge for. You can charge for items that you've added to your catalog by passing the Paddle ID of an existing price entity, or you can charge for non-catalog items by passing a price object.
Non-catalog items can be for existing products, or you can pass a product object as part of your price to charge for a non-catalog product.
pri_01gsz8z1q1n00f12qt82y31smhpri_.^pri_[a-z\d]{26}$product_id to relate this non-catalog price to an existing catalog price.null if price is non-recurring (one-time).dayweekmonthyearnull for no trial period. Requires billing_cycle.dayweekmonthyearaccount_settingaccount_settingexternalinternallocationunit_price_overrides.USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARADAEAGAIALAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBZCACCCGCHCICKCLCMCNCOCRCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHUIDIEILIMINIOIQISITJEJMJOJPKEKGKHKIKMKNKRKWKYKZLALBLCLILKLRLSLTLULVMAMCMDMEMFMGMHMKMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRWSASBSCSESGSHSISJSKSLSMSNSRSTSVSXSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVGVIVNVUWFWSXKYTZAZMUSDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZAR{"minimum":1,"maximum":100}11maximum set.100100minimum set. Must be greater than or equal to the minimum value.{"customer_reference_id":"abcd1234"}pro_01gsz97mq9pa4fkyy0wqenepkzpro_.^pro_[a-z\d]{26}$product object to create a non-catalog product for this non-catalog price.null if price is non-recurring (one-time).dayweekmonthyearnull for no trial period. Requires billing_cycle.dayweekmonthyearaccount_settingaccount_settingexternalinternallocationunit_price_overrides.USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARADAEAGAIALAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBZCACCCGCHCICKCLCMCNCOCRCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHUIDIEILIMINIOIQISITJEJMJOJPKEKGKHKIKMKNKRKWKYKZLALBLCLILKLRLSLTLULVMAMCMDMEMFMGMHMKMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRWSASBSCSESGSHSISJSKSLSMSNSRSTSVSXSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVGVIVNVUWFWSXKYTZAZMUSDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZAR{"minimum":1,"maximum":100}11maximum set.100100minimum set. Must be greater than or equal to the minimum value.{"customer_reference_id":"abcd1234"}digital-goodsebooksimplementation-servicesprofessional-servicessaassoftware-programming-servicesstandardtraining-serviceswebsite-hosting{"customer_reference_id":"abcd1234"}billing_details.enable_checkout is true.Checkout URL to use for the payment link for this transaction. Pass the URL for an approved domain, or null to set to your default payment URL.
Paddle returns a unique payment link composed of the URL passed or your default payment URL + ?_ptxn= and the Paddle ID for this transaction.
creatorId: 12345\ninitialTransactionNumber: a31676f7-a17d-46ce-a111-d860adc92f19txn_01h04vsbhqc62t8hmd4z3b578ctxn_.^txn_[a-z\d]{26}$billed or canceled, other statuses are set automatically by Paddle. Automatically-collected transactions may return completed if payment is captured successfully, or past_due if payment failed.draftreadybilled or completed.billedbilled. Billed transactions get an invoice number and are considered a legal record. They cannot be changed. Typically used as part of an invoice workflow.paidcompletedcanceledcanceled. If an invoice, it's no longer due.past_duectm_01grnn4zta5a1mf02jjze7y2ysctm_.^ctm_[a-z\d]{26}$add_01gm302t81w94gyjpjpqypkzkfadd_.^add_[a-z\d]{26}$biz_01grrebrzaee2qj2fqqhmcyzajbiz_.^biz_[a-z\d]{26}${"customer_reference_id":"abcd1234"}USD, EUR, or GBP if collection_mode is manual.USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARapisubscription_chargesubscription_payment_method_changesubscription_recurringsubscription_updatewebsub_01h04vsc0qhwtsbsxh3422wjs4sub_.^sub_[a-z\d]{26}$inv_01ghbk4xjn4qdsmstcwzgcgg35inv_. Used for compatibility with the Paddle Invoice API, which is now deprecated. This field is scheduled to be removed in the next version of the Paddle API.^inv_[a-z\d]{26}$123-45678billed where collection_mode is manual.automaticautomatic for checkout, manual for invoices.automaticmanualbilling_details.dsc_01gv5kpg05xp104ek2fmgjwttfdsc_.^dsc_[a-z\d]{26}$collection_mode is manual.falsefalse.dayweekmonthyear2024-10-12T07:20:50.52Z2024-10-12T07:20:50.52Zdetails.line_items.pri_01gsz8z1q1n00f12qt82y31smhpri_.^pri_[a-z\d]{26}$pro_01gsz97mq9pa4fkyy0wqenepkzpro_.^pro_[a-z\d]{26}$standardcustomstandardnull if price is non-recurring (one-time).dayweekmonthyearnull for no trial period. Requires billing_cycle.dayweekmonthyeartruetrue) 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_price_overrides. If null, customers are not charged during the trial.USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARADAEAGAIALAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBZCACCCGCHCICKCLCMCNCOCRCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHUIDIEILIMINIOIQISITJEJMJOJPKEKGKHKIKMKNKRKWKYKZLALBLCLILKLRLSLTLULVMAMCMDMEMFMGMHMKMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRWSASBSCSESGSHSISJSKSLSMSNSRSTSVSXSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVGVIVNVUWFWSXKYTZAZMUSDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARaccount_settingaccount_settingexternalinternallocationunit_price_overrides.USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARADAEAGAIALAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBZCACCCGCHCICKCLCMCNCOCRCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHUIDIEILIMINIOIQISITJEJMJOJPKEKGKHKIKMKNKRKWKYKZLALBLCLILKLRLSLTLULVMAMCMDMEMFMGMHMKMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRWSASBSCSESGSHSISJSKSLSMSNSRSTSVSXSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVGVIVNVUWFWSXKYTZAZMUSDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZAR{"minimum":1,"maximum":100}11maximum set.100100minimum set. Must be greater than or equal to the minimum value.activeactivearchived{"customer_reference_id":"abcd1234"}null if this entity is not imported.9b95b0b8-e10f-441a-862e-1936a6d818abpaddle_classic2024-10-12T07:20:50.52Z2024-10-13T07:20:50.52Zproration_billing_mode was prorated_immediately or prorated_next_billing_period. Set automatically by Paddle.2024-10-12T07:20:50.52Z2024-10-12T07:20:50.52Z0.2150000Total discount as a result of any discounts applied.
Except for percentage discounts, Paddle applies tax to discounts based on the line item price.tax_mode. If price.tax_mode for a line item is internal, Paddle removes tax from the discount applied.
150016500150000Total discount as a result of any discounts applied.
Except for percentage discounts, Paddle applies tax to discounts based on the line item price.tax_mode. If price.tax_mode for a line item is internal, Paddle removes tax from the discount applied.
1500165000billed transaction.0details.line_items. This credit is added to the customer balance.165001650083grand_total. Equals the full tax amount unless credits are applied, in which case this value is proportionally reduced.825null until the transaction is completed and the fee is processed.15675null until the transaction is completed and the fee is processed.USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZAR150001500165001650083grand_total. Equals the full tax amount unless credits are applied, in which case this value is proportionally reduced.825null until the transaction is completed and the fee is processed.30015675null until the transaction is completed and the fee is processed.USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARnull until the transaction is completed. Returned in your payout currency.150000price.tax_mode. If price.tax_mode for a line item is internal, Paddle removes tax from the discount applied.1500165000billed transaction.0details.line_items. This credit is added to the customer balance.165001650083grand_total. Equals the full tax amount unless credits are applied, in which case this value is proportionally reduced.82515675AUDCADCHFCNYCZKDKKEURGBPHUFPLNSEKUSDZAR11.05131351.0 if the transaction currency matches your payout currency.0.05null until the transaction is completed.150001500165008253001680null when the chargeback fee is the same as the payout currency.1500USDAUDCADEURGBPUSD15675AUDCADCHFCNYCZKDKKEURGBPHUFPLNSEKUSDZAR1.05131351.0 if the transaction currency matches your payout currency.items as they include totals calculated by Paddle. Considered the source of truth for line item totals.pri_01gsz8z1q1n00f12qt82y31smhpri_.^pri_[a-z\d]{26}$proration_billing_mode was prorated_immediately or prorated_next_billing_period. Set automatically by Paddle.2024-10-12T07:20:50.52Z2024-10-12T07:20:50.52Z0.2150000Total discount as a result of any discounts applied.
Except for percentage discounts, Paddle applies tax to discounts based on the line item price.tax_mode. If price.tax_mode for a line item is internal, Paddle removes tax from the discount applied.
150016500150000Total discount as a result of any discounts applied.
Except for percentage discounts, Paddle applies tax to discounts based on the line item price.tax_mode. If price.tax_mode for a line item is internal, Paddle removes tax from the discount applied.
150016500pro_01gsz97mq9pa4fkyy0wqenepkzpro_.^pro_[a-z\d]{26}$standardcustomstandarddigital-goodsebooksimplementation-servicesprofessional-servicessaassoftware-programming-servicesstandardtraining-serviceswebsite-hosting{"customer_reference_id":"abcd1234"}activeactivearchivednull if this entity is not imported.9b95b0b8-e10f-441a-862e-1936a6d818abpaddle_classic2024-10-12T07:20:50.52Z2024-10-13T07:20:50.52Ztxnitm_01gm302t81w94gyjpjpqypkzkftxnitm_. Used when working with adjustments.^txnitm_[a-z\d]{26}$created_at in descending order, so most recent attempts are returned first.497f776b-851d-4ebf-89ab-8ba0f75d2d6a7636e781-3969-49f4-9c77-8226232e28a6payment_method_id instead.paymtd_01hkm9xwqpbbpr1ksmvg3sx3v1paymtd_.^paymtd_[a-z\d]{26}$1050authorizedauthorized_flaggedcanceledauthorized_flagged payment attempts are rejected.capturederrorerror_code for more information.action_requiredpending_no_action_requiredcreatedunknowndroppednull if payment captured successfully.already_canceledalready_refundedauthentication_failedblocked_cardcanceleddeclineddeclined_not_retryableexpired_cardinvalid_payment_details, depending on how a payment is routed.fraudinvalid_amountinvalid_payment_detailsexpired_card is returned by the payment method issuer, rather than the payment service provider.issuer_unavailablenot_enough_balancepreferred_network_not_supportedprepaid_card_not_supportedpsp_errorredacted_payment_methodsystem_errortransaction_not_permittedunknownalipayapple_paybancontactblikcardgoogle_payidealkakao_paykorea_localunderlying_payment_method.korea_local for information about the Korean payment method used to pay.south_korea_local_cardmb_waynaver_payofflinepaycopaypalpixsamsung_payunknownupiwechat_paywire_transferkorea_local. Deprecated - use top-level type objects instead.null unless the type is korea_local.bccitihanahyundaijejujeonbukkakaobankkakaopaykbankkdbbankkookminkwangjulottemgnaverpaycardnaverpaypointnhpaycopostsamsungsamsungpaysavingsbankshinhanshinhyupsuhyuptossbankunknownwoorinull unless type is south_korea_local_card.bccitihanahyundaijejujeonbukkakaobankkbankkdbbankkookminkwangjulottemgnhpostsamsungsavingsbankshinhanshinhyupsuhyuptossbankunknownwoori4242null unless type is card.american_expressdiners_clubdiscoverjcbmadamaestromastercardunion_payunknownvisa4242122028null unless type is paypal.john.doe@example.comnull for one-off PayPal payments.2024-10-12T07:20:50.52Z2024-10-12T07:20:50.52Znull if status is not captured.billing_details.enable_checkout is true for manually-collected transactions; null otherwise.?_ptxn= and the Paddle ID for this transaction.2024-10-12T07:20:50.52Z2024-10-13T07:20:50.52Z2024-10-12T07:20:50.52Zbilled. null for transactions that aren't billed or completed. Set automatically by Paddle.2024-10-12T07:20:50.52Znull if not revised. Set automatically by Paddle.creatorId: 12345\ninitialTransactionNumber: a31676f7-a17d-46ce-a111-d860adc92f19revised_at is not null. Returned when the include parameter is used with the address value and the transaction has an address_id.add_01gm302t81w94gyjpjpqypkzkfadd_.^add_[a-z\d]{26}$^[a-z0-9_]+$ctm_01grnn4zta5a1mf02jjze7y2ysctm_.^ctm_[a-z\d]{26}$Paddle.com3811 Ditmars BlvdAstoria11105-1803NYADAEAGAIALAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBZCACCCGCHCICKCLCMCNCOCRCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHUIDIEILIMINIOIQISITJEJMJOJPKEKGKHKIKMKNKRKWKYKZLALBLCLILKLRLSLTLULVMAMCMDMEMFMGMHMKMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRWSASBSCSESGSHSISJSKSLSMSNSRSTSVSXSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVGVIVNVUWFWSXKYTZAZM{"customer_reference_id":"abcd1234"}activeactivearchived2024-10-12T07:20:50.52Z2024-10-13T07:20:50.52Znull if this entity is not imported.9b95b0b8-e10f-441a-862e-1936a6d818abpaddle_classicinclude parameter is used with the adjustment value and the transaction has adjustments.adj_01gya6twkp8y0tv1e19rsgst9madj_.^adj_[a-z\d]{26}$creditrefundchargebackchargeback_reversechargeback_warningchargeback_warning_reversecredit_reversepartialpartialfull to adjust the grand total for the related transaction. Include an items array when creating a partial adjustment. If omitted, defaults to partial.fullpartialitems.txn_01h04vsbhqc62t8hmd4z3b578ctxn_.^txn_[a-z\d]{26}$sub_01h04vsc0qhwtsbsxh3422wjs4sub_.
Set automatically by Paddle based on the subscription_id of the related transaction.^sub_[a-z\d]{26}$ctm_01grnn4zta5a1mf02jjze7y2ysctm_.
Set automatically by Paddle based on the customer_id of the related transaction.^ctm_[a-z\d]{26}$credit adjustments.currency_code of the related transaction.USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARStatus of this adjustment. Set automatically by Paddle.
Most refunds for live accounts are created with the status of pending_approval until reviewed by Paddle, but some are automatically approved. For sandbox accounts, Paddle automatically approves refunds every ten minutes.
Credit adjustments don't require approval from Paddle, so they're created as approved.
pending_approvalapprovedpending_approval.rejectedpending_approval.reversedchargeback_reversal or credit_reversal adjustment is created for this adjustment.type is not populated or set to partial.adjitm_01gw4rs4kex0prncwfne87ft8xadjitm_.^adjitm_[a-z\d]{26}$txnitm_01gm302t81w94gyjpjpqypkzkftxnitm_.^txnitm_[a-z\d]{26}$fulltax adjustments are automatically created by Paddle.
Include amount when creating a partial adjustment.fullpartialamount to specify the partial amount adjusted.taxprorationtype is partial.2024-10-12T07:20:50.52Z2024-10-12T07:20:50.52Z150001500165001500015001650030030014700USDUSDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZAR15000150016500300300action is chargeback or chargeback_warning.1680null when the chargeback fee is the same as the payout currency.1500USDAUDCADEURGBPUSD15120AUDCADCHFCNYCZKDKKEURGBPHUFPLNSEKUSDZAR0.2150001500165002024-10-12T07:20:50.52Z2024-10-13T07:20:50.52Zinclude parameter is used with the adjustments_totals value.1500015001650030030014700825082500USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARrevised_at is not null. Returned when the include parameter is used with the business value and the transaction has a business_id.biz_01grrebrzaee2qj2fqqhmcyzajbiz_.^biz_[a-z\d]{26}$^[a-z0-9_]+$ctm_01grnn4zta5a1mf02jjze7y2ysctm_.^ctm_[a-z\d]{26}$123456789AB0123456789activeactivearchivedtest@paddle.com2024-10-12T07:20:50.52Z2024-10-13T07:20:50.52Z{"customer_reference_id":"abcd1234"}null if this entity is not imported.9b95b0b8-e10f-441a-862e-1936a6d818abpaddle_classicrevised_at is not null. Returned when the include parameter is used with the customer value and the transaction has a customer_id.ctm_01grnn4zta5a1mf02jjze7y2ysctm_.^ctm_[a-z\d]{26}$^[a-z0-9_]+$collection_mode is manual (invoices).test@paddle.comfalsefalse unless customers check the marketing consent box
when using Paddle Checkout. Set automatically by Paddle.activeactivearchived{"customer_reference_id":"abcd1234"}enen.2024-10-12T07:20:50.52Z2024-10-13T07:20:50.52Znull if this entity is not imported.9b95b0b8-e10f-441a-862e-1936a6d818abpaddle_classicinclude parameter is used with the discount value and the transaction has a discount_id.dsc_01gv5kpg05xp104ek2fmgjwttfdsc_.^dsc_[a-z\d]{26}$^[a-z0-9_]+$activeactivearchivedtruetrue) or not (false).^[a-zA-Z0-9]{1,32}$flatcurrency_code.flat_per_seatcurrency_code.percentagestandardstandardcustompercentage discounts, must be an amount between 0.01 and 100. For flat and flat_per_seat discounts, amount in the lowest denomination for a currency.flat or flat_per_seat.USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARfalsetrue) or not (false).Number of subscription billing periods that this discount recurs for. Requires recur. null if this discount recurs forever.
Subscription renewals, midcycle changes, and one-time charges billed to a subscription aren't considered a redemption. times_used is not incremented in these cases.
Maximum number of times this discount can be redeemed. This is an overall limit for this discount, rather than a per-customer limit. null if this discount can be redeemed an unlimited amount of times.
Paddle counts a usage as a redemption on a checkout, transaction, or the initial application against a subscription. Transactions created for subscription renewals, midcycle changes, and one-time charges aren't considered a redemption.
null if this discount applies to all products and prices.2024-10-12T07:20:50.52ZRFC 3339 datetime string of when this discount expires. Discount can no longer be redeemed after this date has elapsed. null if this discount can be redeemed forever.
Expired discounts can't be redeemed against transactions or checkouts, but can be applied when updating subscriptions.
{"customer_reference_id":"abcd1234"}How many times this discount has been redeemed. Automatically incremented by Paddle.
Paddle counts a usage as a redemption on a checkout, transaction, or subscription. Transactions created for subscription renewals, midcycle changes, and one-time charges aren't considered a redemption.
dsg_01js2gqehzccfkywgx1jk2mtspdsg_. null if not in a discount group.^dsg_[a-z\d]{26}$2024-10-12T07:20:50.52Z2024-10-13T07:20:50.52Znull if this entity is not imported.9b95b0b8-e10f-441a-862e-1936a6d818abpaddle_classicinclude parameter is used with the available_payment_methods value.alipayapple_paybancontactblikcardgoogle_payidealkakao_paykorea_localnaver_paypaycosamsung_paysouth_korea_local_cardmb_waypaypalpixupiwechat_payb15ec92e-8688-40d4-a04d-f44cbec93355{ "items": [ { "quantity": 20, "price_id": "pri_01gsz91wy9k1yn7kx82aafwvea" }, { "quantity": 1, "price_id": "pri_01gsz96z29d88jrmsf2ztbfgjg" }, { "quantity": 1, "price_id": "pri_01gsz98e27ak2tyhexptwc58yk" } ], "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4", "address_id": "add_01hv8gq3318ktkfengj2r75gfx", "currency_code": "USD", "collection_mode": "manual", "billing_details": { "enable_checkout": false, "purchase_order_number": "PO-123", "payment_terms": { "interval": "day", "frequency": 14 } }, "billing_period": { "starts_at": "2024-04-12T00:00:00Z", "ends_at": "2025-04-11T23:59:00Z" }}{ "data": { "id": "txn_01hv8m0mnx3sj85e7gxc6kga03", "status": "ready", "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4", "address_id": "add_01hv8gq3318ktkfengj2r75gfx", "business_id": null, "custom_data": null, "origin": "api", "collection_mode": "manual", "subscription_id": null, "invoice_id": null, "invoice_number": null, "discount_id": null, "billing_details": { "enable_checkout": false, "payment_terms": { "interval": "day", "frequency": 14 }, "purchase_order_number": "PO-123", "additional_information": null }, "billing_period": { "starts_at": "2024-04-12T00:00:00Z", "ends_at": "2025-04-11T23:59:00Z" }, "currency_code": "USD", "created_at": "2024-04-12T07:40:38.007040251Z", "updated_at": "2024-04-12T07:40:38.007040251Z", "billed_at": null, "revised_at": null, "items": [ { "price": { "id": "pri_01gsz91wy9k1yn7kx82aafwvea", "description": "Annual", "type": "standard", "name": "Annual (per seat)", "product_id": "pro_01gsz4vmqbjk3x4vvtafffd540", "billing_cycle": { "interval": "year", "frequency": 1 }, "trial_period": null, "tax_mode": "account_setting", "unit_price": { "amount": "50000", "currency_code": "USD" }, "unit_price_overrides": [], "custom_data": null, "quantity": { "minimum": 1, "maximum": 100 }, "status": "active", "created_at": "2023-02-23T13:57:54.249913Z", "updated_at": "2024-04-05T14:32:00.471447Z", "import_meta": null }, "quantity": 20, "proration": null }, { "price": { "id": "pri_01gsz96z29d88jrmsf2ztbfgjg", "description": "Annual (recurring addon)", "type": "standard", "name": "Annual (recurring addon)", "product_id": "pro_01gsz92krfzy3hcx5h5rtgnfwz", "billing_cycle": { "interval": "year", "frequency": 1 }, "trial_period": null, "tax_mode": "account_setting", "unit_price": { "amount": "300000", "currency_code": "USD" }, "unit_price_overrides": [], "custom_data": null, "quantity": { "minimum": 1, "maximum": 1 }, "status": "active", "created_at": "2023-02-23T14:00:40.265185Z", "updated_at": "2024-03-25T14:31:18.587603Z", "import_meta": null }, "quantity": 1, "proration": null }, { "price": { "id": "pri_01gsz98e27ak2tyhexptwc58yk", "description": "One-time addon", "type": "standard", "name": "One-time addon", "product_id": "pro_01gsz97mq9pa4fkyy0wqenepkz", "billing_cycle": null, "trial_period": null, "tax_mode": "account_setting", "unit_price": { "amount": "19900", "currency_code": "USD" }, "unit_price_overrides": [], "custom_data": null, "quantity": { "minimum": 1, "maximum": 1 }, "status": "active", "created_at": "2023-02-23T14:01:28.391712Z", "updated_at": "2024-04-09T07:23:10.921392Z", "import_meta": null }, "quantity": 1, "proration": null } ], "details": { "tax_rates_used": [ { "tax_rate": "0.08875", "totals": { "subtotal": "1319900", "discount": "0", "tax": "117141", "total": "1437041" } } ], "totals": { "subtotal": "1319900", "tax": "117141", "discount": "0", "total": "1437041", "grand_total": "1437041", "grand_total_tax": "117141", "fee": null, "credit": "0", "credit_to_balance": "0", "balance": "1437041", "earnings": null, "currency_code": "USD" }, "adjusted_totals": { "subtotal": "1319900", "tax": "117141", "total": "1437041", "grand_total": "1437041", "grand_total_tax": "117141", "fee": "0", "earnings": "0", "currency_code": "USD", "retained_fee": "0" }, "payout_totals": null, "adjusted_payout_totals": null, "line_items": [ { "id": "txnitm_01hv8m0n6xqk32jsq5q6pv7mpk", "price_id": "pri_01gsz91wy9k1yn7kx82aafwvea", "quantity": 20, "totals": { "subtotal": "1000000", "tax": "88750", "discount": "0", "total": "1088750" }, "product": { "id": "pro_01gsz4vmqbjk3x4vvtafffd540", "name": "AeroEdit Enterprise", "description": "The ultimate solution for organizations, featuring all Pro capabilities plus multi-user support, advanced data storage capabilities, plus personalized onboarding, dedicated account management, and the ability to pay via invoice.", "type": "standard", "tax_category": "standard", "image_url": "https://paddle.s3.amazonaws.com/user/165798/Ws808ziTS76a6YbnMkiK_enterprise.png", "custom_data": { "features": { "aircraft_performance": true, "compliance_monitoring": true, "flight_log_management": true, "payment_by_invoice": true, "route_planning": true, "sso": true }, "suggested_addons": [], "upgrade_description": "Ready to reach new heights? Upgrade to enterprise to unlock single sign-on, payment by invoice, and dedicated account management." }, "status": "active", "created_at": "2023-02-23T12:44:34.923Z", "updated_at": "2024-04-05T15:58:28.309Z", "import_meta": null }, "tax_rate": "0.08875", "unit_totals": { "subtotal": "50000", "tax": "4437", "discount": "0", "total": "54437" }, "proration": null }, { "id": "txnitm_01hv8m0n6yajavvy3q3297hd45", "price_id": "pri_01gsz96z29d88jrmsf2ztbfgjg", "quantity": 1, "totals": { "subtotal": "300000", "tax": "26625", "discount": "0", "total": "326625" }, "product": { "id": "pro_01gsz92krfzy3hcx5h5rtgnfwz", "name": "VIP support", "description": "Get exclusive access to our expert team of product specialists, available to help you make the most of your AeroEdit subscription.", "type": "standard", "tax_category": "standard", "image_url": "https://paddle.s3.amazonaws.com/user/165798/qgyipKJwRtq98YNboipo_vip-support.png", "custom_data": null, "status": "active", "created_at": "2023-02-23T13:58:17.615Z", "updated_at": "2024-04-05T15:44:02.893Z", "import_meta": null }, "tax_rate": "0.08875", "unit_totals": { "subtotal": "300000", "tax": "26625", "discount": "0", "total": "326625" }, "proration": null }, { "id": "txnitm_01hv8m0n6yajavvy3q376fjpht", "price_id": "pri_01gsz98e27ak2tyhexptwc58yk", "quantity": 1, "totals": { "subtotal": "19900", "tax": "1766", "discount": "0", "total": "21666" }, "product": { "id": "pro_01gsz97mq9pa4fkyy0wqenepkz", "name": "Custom domains", "description": "Make AeroEdit truly your own with custom domains. Custom domains reinforce your brand identity and make it easy for your team to access your account.", "type": "standard", "tax_category": "standard", "image_url": "https://paddle.s3.amazonaws.com/user/165798/XIG7UXoJQHmlIAiKcnkA_custom-domains.png", "custom_data": null, "status": "active", "created_at": "2023-02-23T14:01:02.441Z", "updated_at": "2024-04-05T15:43:28.971Z", "import_meta": null }, "tax_rate": "0.08875", "unit_totals": { "subtotal": "19900", "tax": "1766", "discount": "0", "total": "21666" }, "proration": null } ] }, "payments": [], "checkout": { "url": null } }, "meta": { "request_id": "c7db9b4e-da8c-4b05-871b-f7f47264fd72" }}Paddle.com Market Ltd. 20122026
| Web Proxy Viewer | New URL | Original Page |