Activate order and process payment | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        environment: "https://api.agentpaid.io/api/v1",
        token: "YOUR_TOKEN_HERE",
    });
    await client.orders.activateAndPay("orderId", {
        confirmationToken: "pi_1F4Z7SH8dsf7aX9Yz0qL3v2b_confirm",
        returnUrl: "https://myshop.com/order/complete",
    });
}
main();

{
  "id": "ord_9876543210",
  "name": "Premium Subscription Plan",
  "description": "Activation of the premium monthly subscription",
  "customerId": "cust_1234567890",
  "organizationId": "org_1122334455",
  "startDate": "2024-06-01T00:00:00Z",
  "endDate": "2025-05-31T23:59:59Z",
  "totalAmount": 199.99,
  "estimatedTax": 15,
  "billedAmountNoTax": 199.99,
  "billedTax": 15,
  "totalBilledAmount": 214.99,
  "pendingBillingAmount": 0,
  "creationState": "active",
  "orderLines": [
    {
      "id": "ol_0011223344",
      "orderId": "ord_9876543210",
      "agentId": "agent_5566778899",
      "name": "Monthly Subscription Fee",
      "description": "Access to all premium features for one month",
      "startDate": "2024-06-01T00:00:00Z",
      "endDate": "2024-06-30T23:59:59Z",
      "totalAmount": 199.99,
      "billedAmountWithoutTax": 199.99,
      "billedTax": 15,
      "totalBilledAmount": 214.99,
      "creationState": "active",
      "agent": {
        "id": "agent_5566778899",
        "organizationId": "org_1122334455",
        "name": "Premium Service Agent",
        "active": true,
        "externalId": "ext_agent_001",
        "description": "Handles premium subscription services",
        "agentCode": "PSA-1001",
        "agentAttributes": [
          {
            "name": "Subscription Access",
            "active": true,
            "pricing": {
              "taxable": true,
              "chargeType": "recurring",
              "pricingModel": "PerUnit",
              "billingFrequency": "monthly",
              "pricePoints": {},
              "eventName": "subscription_start",
              "creditCost": 0
            }
          }
        ]
      },
      "orderLineAttributes": [
        {
          "agentAttributeId": "attr_3344556677",
          "quantity": 1,
          "currency": "USD",
          "pricing": {
            "eventName": "subscription_fee",
            "chargeType": "recurring",
            "pricePoint": {
              "currency": "USD",
              "unitPrice": 199.99,
              "minQuantity": 1,
              "tiers": [
                {
                  "lowerBound": 1,
                  "upperBound": 10,
                  "price": 199.99
                }
              ]
            },
            "pricingModel": "PerUnit",
            "billingFrequency": "monthly"
          }
        }
      ]
    }
  ],
  "customer": {
    "id": "cust_1234567890",
    "organizationId": "org_1122334455",
    "name": "Acme Corporation",
    "externalId": "ACME-2024",
    "phone": "+1-555-123-4567",
    "employeeCount": 250,
    "annualRevenue": 50000000,
    "taxExemptStatus": "none",
    "creationSource": "api",
    "creationState": "active",
    "website": "https://acme-corp.com",
    "billingAddress": {
      "line1": "123 Business Rd",
      "city": "Metropolis",
      "state": "NY",
      "zipCode": "10001",
      "country": "USA",
      "line2": "Suite 400"
    },
    "metadata": {}
  }
}

Activates the order and processes the initial payment using the provided Stripe confirmation token.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

orderIdstringRequired

The order ID (can be internal ID or display ID)

Request

This endpoint expects an object.

confirmationTokenstringRequired

Stripe confirmation token for the payment method

returnUrlstringRequired

URL to redirect to after payment processing

Response

Order activated and payment processed successfully

idstring or null

namestring or null

descriptionstring or null

customerIdstring or null

organizationIdstring or null

startDatestring or null

endDatestring or null

totalAmountdouble or null

estimatedTaxdouble or null

billedAmountNoTaxdouble or null

billedTaxdouble or null

totalBilledAmountdouble or null

pendingBillingAmountdouble or null

creationStateenum or null

Allowed values:

orderLineslist of objects or null

customerobject or null

Authentication

Path parameters

Request

Response

Errors