Activate order and process payment | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.orders.activateAndPay("orderId", {
        confirmationToken: "ctoken_1234567890",
        returnUrl: "https://example.com/payment-complete",
    });
}
main();

{
  "id": "string",
  "name": "string",
  "description": "string",
  "customerId": "string",
  "organizationId": "string",
  "startDate": "string",
  "endDate": "string",
  "totalAmount": 1.1,
  "estimatedTax": 1.1,
  "billedAmountNoTax": 1.1,
  "billedTax": 1.1,
  "totalBilledAmount": 1.1,
  "pendingBillingAmount": 1.1,
  "creationState": "active",
  "orderLines": [
    {
      "id": "string",
      "orderId": "string",
      "agentId": "string",
      "name": "string",
      "description": "string",
      "startDate": "string",
      "endDate": "string",
      "totalAmount": 1.1,
      "billedAmountWithoutTax": 1.1,
      "billedTax": 1.1,
      "totalBilledAmount": 1.1,
      "creationState": "active",
      "agent": {
        "id": "string",
        "organizationId": "string",
        "name": "string",
        "active": true,
        "externalId": "string",
        "description": "string",
        "agentCode": "string",
        "agentAttributes": [
          {
            "name": "string",
            "active": true,
            "pricing": {
              "taxable": true,
              "chargeType": "oneTime",
              "pricingModel": "PerUnit",
              "billingFrequency": "monthly",
              "pricePoints": {},
              "eventName": "string",
              "creditCost": 1.1
            }
          }
        ]
      },
      "orderLineAttributes": [
        {
          "agentAttributeId": "string",
          "quantity": 1.1,
          "currency": "string",
          "pricing": {
            "eventName": "string",
            "chargeType": "oneTime",
            "pricePoint": {
              "currency": "string",
              "unitPrice": 1.1,
              "minQuantity": 1.1,
              "tiers": [
                {
                  "lowerBound": 1.1,
                  "upperBound": 1.1,
                  "price": 1.1
                }
              ]
            },
            "pricingModel": "PerUnit",
            "billingFrequency": "monthly"
          }
        }
      ]
    }
  ],
  "customer": {
    "id": "string",
    "organizationId": "string",
    "name": "string",
    "externalId": "string",
    "phone": "string",
    "employeeCount": 1.1,
    "annualRevenue": 1.1,
    "taxExemptStatus": "none",
    "creationSource": "manual",
    "creationState": "active",
    "website": "string",
    "billingAddress": {
      "line1": "string",
      "city": "string",
      "state": "string",
      "zipCode": "string",
      "country": "string",
      "line2": "string"
    },
    "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

idstringOptional

namestringOptional

descriptionstringOptional

customerIdstringOptional

organizationIdstringOptional

startDatestringOptional

endDatestringOptional

totalAmountdoubleOptional

estimatedTaxdoubleOptional

billedAmountNoTaxdoubleOptional

billedTaxdoubleOptional

totalBilledAmountdoubleOptional

pendingBillingAmountdoubleOptional

creationStateenumOptional

orderLineslist of objectsOptional

customerobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error