Skip to main content
POST
/
transactions
/
{transaction_id}
/
revise
Revise customer information on a billed or completed transaction
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer: {name: 'Sam Miller'},
    business: {tax_identifier: 'AB0123456789'},
    address: {first_line: '3811 Ditmars Blvd'}
  })
};

fetch('https://api.paddle.com/transactions/{transaction_id}/revise', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "txn_01hv8wptq8987qeep44cyrewp9",
    "status": "completed",
    "customer_id": "ctm_01hv8wt8nffez4p2t6typn4a5j",
    "address_id": "add_01hv8wt8ny8ms5vtm71bj8vcdd",
    "business_id": null,
    "custom_data": null,
    "origin": "web",
    "collection_mode": "automatic",
    "subscription_id": "sub_01hv8x29kz0t586xy6zn1a62ny",
    "invoice_id": "inv_01hv8x29nsh54c2pgt0hnq0zkx",
    "invoice_number": "325-10566",
    "billing_details": null,
    "billing_period": {
      "starts_at": "2024-04-12T10:18:47.635628Z",
      "ends_at": "2024-05-12T10:18:47.635628Z"
    },
    "currency_code": "USD",
    "discount_id": null,
    "created_at": "2024-04-12T10:12:33.2014Z",
    "updated_at": "2024-07-26T08:46:00.746349Z",
    "billed_at": "2024-04-12T10:18:48.294633Z",
    "revised_at": "2024-07-26T08:46:00.746349Z",
    "items": [
      {
        "price": {
          "id": "pri_01gsz8x8sawmvhz1pv30nge1ke",
          "description": "Monthly",
          "type": "standard",
          "name": "Monthly (per seat)",
          "product_id": "pro_01gsz4t5hdjse780zja8vvr7jg",
          "billing_cycle": {
            "interval": "month",
            "frequency": 1
          },
          "trial_period": null,
          "tax_mode": "account_setting",
          "unit_price": {
            "amount": "3000",
            "currency_code": "USD"
          },
          "unit_price_overrides": [],
          "custom_data": null,
          "quantity": {
            "minimum": 1,
            "maximum": 999
          },
          "status": "active",
          "created_at": "2023-02-23T13:55:22.538367Z",
          "updated_at": "2024-04-11T13:54:52.254748Z"
        },
        "quantity": 10
      },
      {
        "price": {
          "id": "pri_01h1vjfevh5etwq3rb416a23h2",
          "description": "Monthly",
          "type": "standard",
          "name": "Monthly (recurring addon)",
          "product_id": "pro_01h1vjes1y163xfj1rh1tkfb65",
          "billing_cycle": {
            "interval": "month",
            "frequency": 1
          },
          "trial_period": null,
          "tax_mode": "account_setting",
          "unit_price": {
            "amount": "10000",
            "currency_code": "USD"
          },
          "unit_price_overrides": [],
          "custom_data": null,
          "quantity": {
            "minimum": 1,
            "maximum": 100
          },
          "status": "active",
          "created_at": "2023-06-01T13:31:12.625056Z",
          "updated_at": "2024-04-09T07:23:00.907834Z",
          "import_meta": null
        },
        "quantity": 1
      },
      {
        "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
      }
    ],
    "details": {
      "tax_rates_used": [
        {
          "tax_rate": "0.08875",
          "totals": {
            "subtotal": "59900",
            "discount": "0",
            "tax": "5315",
            "total": "65215"
          }
        }
      ],
      "totals": {
        "subtotal": "59900",
        "tax": "5315",
        "discount": "0",
        "total": "65215",
        "grand_total": "65215",
        "fee": "3311",
        "credit": "0",
        "credit_to_balance": "0",
        "balance": "0",
        "earnings": "56589",
        "currency_code": "USD"
      },
      "adjusted_totals": {
        "subtotal": "59900",
        "tax": "5315",
        "total": "65215",
        "grand_total": "65215",
        "fee": "3311",
        "earnings": "56589",
        "currency_code": "USD"
      },
      "payout_totals": {
        "subtotal": "59900",
        "tax": "5315",
        "discount": "0",
        "total": "65215",
        "credit": "0",
        "credit_to_balance": "0",
        "balance": "0",
        "grand_total": "65215",
        "fee": "3311",
        "earnings": "56589",
        "currency_code": "USD"
      },
      "adjusted_payout_totals": {
        "subtotal": "59900",
        "tax": "5315",
        "total": "65215",
        "fee": "3311",
        "chargeback_fee": {
          "amount": "0",
          "original": null
        },
        "earnings": "56589",
        "currency_code": "USD"
      },
      "line_items": [
        {
          "id": "txnitm_01hv8wt98jahpbm1t1tzr06z6n",
          "price_id": "pri_01gsz8x8sawmvhz1pv30nge1ke",
          "quantity": 10,
          "totals": {
            "subtotal": "30000",
            "tax": "2662",
            "discount": "0",
            "total": "32662"
          },
          "product": {
            "id": "pro_01gsz4t5hdjse780zja8vvr7jg",
            "name": "AeroEdit Pro",
            "description": "Designed for professional pilots, including all features plus in Basic plus compliance monitoring, route optimization, and third-party integrations.",
            "type": "standard",
            "tax_category": "standard",
            "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",
            "created_at": "2023-02-23T12:43:46.605Z",
            "updated_at": "2024-04-05T15:53:44.687Z",
            "import_meta": null
          },
          "tax_rate": "0.08875",
          "unit_totals": {
            "subtotal": "3000",
            "tax": "266",
            "discount": "0",
            "total": "3266"
          }
        },
        {
          "id": "txnitm_01hv8wt98jahpbm1t1v1sd067y",
          "price_id": "pri_01h1vjfevh5etwq3rb416a23h2",
          "quantity": 1,
          "totals": {
            "subtotal": "10000",
            "tax": "887",
            "discount": "0",
            "total": "10887"
          },
          "product": {
            "id": "pro_01h1vjes1y163xfj1rh1tkfb65",
            "name": "Analytics addon",
            "description": "Unlock advanced insights into your flight data with enhanced analytics and reporting features. Includes customizable reporting templates and trend analysis across flights.",
            "type": "standard",
            "tax_category": "standard",
            "image_url": "https://paddle.s3.amazonaws.com/user/165798/97dRpA6SXzcE6ekK9CAr_analytics.png",
            "custom_data": null,
            "status": "active",
            "created_at": "2023-06-01T13:30:50.302Z",
            "updated_at": "2024-04-05T15:47:17.163Z",
            "import_meta": null
          },
          "tax_rate": "0.08875",
          "unit_totals": {
            "subtotal": "10000",
            "tax": "887",
            "discount": "0",
            "total": "10887"
          }
        },
        {
          "id": "txnitm_01hv8wt98jahpbm1t1v67vqnb6",
          "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"
          }
        }
      ]
    },
    "payments": [
      {
        "payment_attempt_id": "937640dd-e3dc-40df-a16c-bb75aafd8f71",
        "stored_payment_method_id": "281ff2ca-8550-42b9-bf39-15948e7de62d",
        "payment_method_id": "paymtd_01hv8x1tpjfnttxddw73xnqx6s",
        "amount": "65215",
        "status": "captured",
        "error_code": null,
        "method_details": {
          "type": "card",
          "card": {
            "type": "visa",
            "last4": "3184",
            "expiry_month": 1,
            "expiry_year": 2025,
            "cardholder_name": "Michael McGovern"
          }
        },
        "created_at": "2024-04-12T10:18:33.579142Z",
        "captured_at": "2024-04-12T10:18:47.635628Z"
      },
      {
        "payment_attempt_id": "8f72cfa6-26b4-4a57-91dc-8f2708f7822d",
        "stored_payment_method_id": "a78ece50-356f-4e0c-b72d-ad5368b0a0d9",
        "payment_method_id": "paymtd_01hv8wx2mka7dfsqjjsxh1ne7z",
        "amount": "65215",
        "status": "error",
        "error_code": "declined",
        "method_details": {
          "type": "card",
          "card": {
            "type": "visa",
            "last4": "0002",
            "expiry_month": 1,
            "expiry_year": 2025,
            "cardholder_name": "Michael McGovern"
          }
        },
        "created_at": "2024-04-12T10:15:57.888183Z",
        "captured_at": null
      }
    ],
    "checkout": {
      "url": "https://aeroedit.com/pay?_ptxn=txn_01hv8wptq8987qeep44cyrewp9"
    }
  },
  "meta": {
    "request_id": "d6186f6a-70f7-4f1c-a65a-f790f940cf6e"
  }
}

Authorizations

​
Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

​
transaction_id
string
required

Paddle ID of the transaction entity to work with.

Example:

"txn_01gw225vv6tjbb5gnt062a3k5v"

Body

application/json

Represents a customer information revision for a transaction.

​
customer
TransactionRevisionCustomer · object

Revised customer information for this transaction.

​
business
TransactionRevisionBusiness · object

Revised business information for this transaction.

​
address
TransactionRevisionAddress · object

Revised address information for this transaction.

Response

OK

​
data
Transaction · object
required

Represents a transaction entity.

​
meta
Meta · object
required

Information about this response.