Update API Reference

sites/com/paddle/developer/api-reference-addresses-overview.txt

@@ -4,7 +4,7 @@ Addresses
 
 Address object
 
-Address entities hold billing address information for a customer. They're sub-entities of customers.
+Address entities hold billing address information for a customer. They're subentities of customers.
 
 Addresses store components of a customer billing address. They're always created against a
 
@@ -14,13 +14,13 @@ You can create as many addresses as you like against a customer — useful for b
 
 Address entities hold address components like:
 
-Country
+Country.
 
-ZIP/postal code
+ZIP/postal code.
 
-State (region)
+State or region.
 
-A short, internal description for this address
+A short, internal description for this address.
 
 Customers, addresses, and
 
@@ -30,21 +30,23 @@ work with
 
 , and
 
-to bill for
+to let customers purchase
 
 and
 
 .
 
-You can't bill a customer without an address. To make buying as frictionless as possible, Paddle only requires a country
+Customers require an address to make a purchase. To make buying as frictionless as possible, Paddle only requires a country
 
 where a ZIP or postal code is also required.
 
-Learn how to create a complete customer with a related address and business. See:
-
 There's no delete operation for addresses. Use the
 
-to archive addresses when you no longer need them. See:
+to archive addresses when you no longer need them. To learn more, see
+
+Create or update a customer
+
+Supported countries
 
 id
 
@@ -56,6 +58,16 @@ add_
 
 .
 
+customer_id
+
+string
+
+Paddle ID for the customer related to this address, prefixed with
+
+cus_
+
+.
+
 description
 
 string or null
@@ -140,17 +152,21 @@ null
 
 if this entity is not imported.
 
-external_id
+imported_from
 
-string or null
+string
 
-Reference or identifier for this entity from the solution where it was imported from.
+Name of the platform or provider where this entity was imported from.
 
-imported_from
+Show
 
-string
+allowed values
+
+external_id
+
+string or null
 
-Name of the platform where this entity was imported from.
+Reference or identifier for this entity from the provider where it was imported from.
 
 List addresses for a customer
 

sites/com/paddle/developer/api-reference-adjustments-overview.txt

@@ -8,19 +8,23 @@ Adjustment entities describe a post-billing adjustment to a billed or completed
 
 Billed transactions are considered financial records for tax and legal purposes, so they can't be changed. Adjustments let you record actions that impact revenue for a transaction after it's been billed.
 
-You can create adjustments for billed or completed transactions to refund or credit all or part of a transaction. Refunds must be approved by Paddle.
+You can create adjustments for billed or completed transactions to refund or credit all or part of a transaction.
 
-Paddle creates adjustments automatically for successful customer chargebacks, as well as subscription lifecycle events depending on the proration options chosen.
+Most refunds for live accounts must be approved by Paddle, but
+
+. For sandbox accounts, Paddle automatically approves all refunds every ten minutes.
+
+Where customers raise a chargeback with their payment method issuer, Paddle automatically creates an adjustment to refund the disputed amount.
 
 Adjustment entities hold information like:
 
-What kind of adjustment it is
+What kind of adjustment it is.
 
-Why the adjustment was created
+Why the adjustment was created.
 
-Which transaction and items an adjustment is for
+Which transaction and items an adjustment is for.
 
-Calculated totals for an adjustment
+Calculated totals for an adjustment.
 
 Adjustments work with
 
@@ -34,6 +38,10 @@ Adjustments are financial records. They can't be deleted or changed once they've
 
 if you need help with an adjustment.
 
+Refund or credit a transaction
+
+Cancel an invoice
+
 id
 
 string
@@ -50,11 +58,29 @@ string
 
 How this adjustment impacts the related transaction.
 
-refund
+Show
 
-adjustments must be approved by Paddle, and are created with the status
+allowed values
 
-pending_approval
+type
+
+string
+
+Type of adjustment. Use
+
+full
+
+to adjust the grand total for the related transaction. Include an
+
+items
+
+array when creating a
+
+partial
+
+adjustment. If omitted, defaults to
+
+partial
 
 .
 
@@ -66,7 +92,7 @@ transaction_id
 
 string
 
-Paddle ID for the transaction related to this adjustment, prefixed with
+Paddle ID of the transaction that this adjustment is for, prefixed with
 
 txn_
 
@@ -108,52 +134,18 @@ reason
 
 string
 
-Why this adjustment was created. Appears in the Paddle Dashboard. Retained for record-keeping purposes.
+Why this adjustment was created. Appears in the Paddle dashboard. Retained for record-keeping purposes.
 
 credit_applied_to_balance
 
-boolean
+boolean or null
 
 Whether this adjustment was applied to the related customer's credit balance. Only returned for
 
 credit
 
 adjustments.
 
-false
-
-when the related transaction
-
-collection_mode
-
-is
-
-manual
-
-and its
-
-status
-
-is
-
-billed
-
-. The adjustment is used
-
-to reduce the
-
-balance
-
-due on the transaction.
-
-true
-
-for automatically-collected transactions and
-
-completed
-
-manually-collected transactions.
-
 currency_code
 
 string
@@ -174,23 +166,13 @@ string
 
 Status of this adjustment. Set automatically by Paddle.
 
-refund
-
-adjustments must be approved by Paddle, and are created with the status
+Most refunds for live accounts are created with the status of
 
 pending_approval
 
-until they move to
-
-approved
-
-or
+until reviewed by Paddle, but some are automatically approved. For sandbox accounts, Paddle automatically approves refunds every ten minutes.
 
-rejected
-
-on review. Other kinds of adjustment do not need approval,
-
-so are created with the status
+Credit adjustments don't require approval from Paddle, so they're created as
 
 approved
 
@@ -204,7 +186,15 @@ items
 
 array[object]
 
-List of items on this adjustment.
+List of items on this adjustment. Required if
+
+type
+
+is not populated or set to
+
+partial
+
+.
 
 id
 
@@ -234,11 +224,7 @@ Type of adjustment for this transaction item.
 
 tax
 
-and
-
-proration
-
-are automatically created by Paddle.
+adjustments are automatically created by Paddle.
 
 Include
 
@@ -258,7 +244,11 @@ amount
 
 string or null
 
-Amount adjusted for this transaction item. Required when adjustment type is
+Amount adjusted for this transaction item. Required when item
+
+type
+
+is
 
 partial
 
@@ -268,13 +258,7 @@ proration
 
 object or null
 
-How proration was calculated for this adjustment item. Populated when an adjustment type is
-
-proration
-
-.
-
-Set automatically by Paddle.
+How proration was calculated for this adjustment item.
 
 totals
 
@@ -382,11 +366,27 @@ chargeback_warning
 
 .
 
+amount
+
+string
+
+Chargeback fee converted into the payout currency.
+
+original
+
+object or null
+
+Chargeback fee before conversion to the payout currency.
+
+null
+
+when the chargeback fee is the same as the payout currency.
+
 earnings
 
 string
 
-Adjusted payout earnings. This is the adjustment total plus adjusted Paddle fees, minus chargeback fees.
+Adjusted payout earnings. This is the adjustment total plus adjusted Paddle fees, excluding chargeback fees.
 
 currency_code
 
@@ -398,6 +398,24 @@ Show
 
 allowed values
 
+tax_rates_used
+
+array[object]
+
+List of tax rates applied for this adjustment.
+
+tax_rate
+
+string
+
+Rate used to calculate tax for this adjustment.
+
+totals
+
+object
+
+Calculated totals for the tax applied to this adjustment.
+
 created_at
 
 string
@@ -425,3 +443,11 @@ post
 https://api.paddle.com
 
 /adjustments
+
+Get a PDF credit note for an adjustment
+
+get
+
+https://api.paddle.com
+
+/adjustments/{adjustment_id}/credit-note