Subscribe customer to plan | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.plans.subscribe("planId", {
        customerExternalId: "customerExternalId",
        currency: "currency",
    });
}
main();

{
  "id": "a3f1c9d2-4b7e-4f9a-9c3d-2e5b7f8a1d4c",
  "name": "Premium Annual Subscription",
  "description": "Subscription order for the Premium Annual Plan",
  "customerId": "c9b1f8e7-2d4a-4f6b-8a9e-3c7d5f1b2a6e",
  "organizationId": "org-1234567890",
  "startDate": "2024-07-01T00:00:00Z",
  "endDate": "2025-06-30T23:59:59Z",
  "totalAmount": 1200,
  "estimatedTax": 96,
  "billedAmountNoTax": 1104,
  "billedTax": 96,
  "totalBilledAmount": 1200,
  "pendingBillingAmount": 0,
  "creationState": "active",
  "orderLines": [
    {
      "id": "ol-7890abcd-1234-5678-9abc-def012345678",
      "orderId": "a3f1c9d2-4b7e-4f9a-9c3d-2e5b7f8a1d4c",
      "agentId": "agent-4567efgh-8901-2345-6789-abcdef012345",
      "name": "Premium Plan Access",
      "description": "Access to all premium features for one year",
      "startDate": "2024-07-01T00:00:00Z",
      "endDate": "2025-06-30T23:59:59Z",
      "totalAmount": 1200,
      "billedAmountWithoutTax": 1104,
      "billedTax": 96,
      "totalBilledAmount": 1200,
      "creationState": "active",
      "agent": {
        "id": "agent-4567efgh-8901-2345-6789-abcdef012345",
        "organizationId": "org-1234567890",
        "name": "Premium Service Agent",
        "active": true,
        "externalId": "AGT-2024-0001",
        "description": "Handles premium subscription services",
        "agentCode": "PSA-001",
        "agentAttributes": [
          {
            "name": "Premium Feature Access",
            "active": true,
            "pricing": {
              "taxable": true,
              "chargeType": "recurring",
              "pricingModel": "PerUnit",
              "billingFrequency": "annual",
              "pricePoints": {
                "default": {
                  "unitPrice": 1200,
                  "minQuantity": 1,
                  "includedQuantity": 0,
                  "tiers": []
                }
              },
              "eventName": "SubscriptionStart",
              "creditCost": 0
            }
          }
        ]
      },
      "orderLineAttributes": [
        {
          "agentAttributeId": "attr-1234abcd-5678-efgh-9012-ijkl3456mnop",
          "quantity": 1,
          "currency": "USD",
          "pricing": {
            "eventName": "SubscriptionStart",
            "chargeType": "recurring",
            "pricePoint": {
              "currency": "USD",
              "unitPrice": 1200,
              "minQuantity": 1,
              "tiers": [
                {
                  "lowerBound": 1,
                  "upperBound": 10,
                  "price": 1200
                }
              ]
            },
            "pricingModel": "PerUnit",
            "billingFrequency": "annual"
          }
        }
      ]
    }
  ],
  "customer": {
    "id": "c9b1f8e7-2d4a-4f6b-8a9e-3c7d5f1b2a6e",
    "organizationId": "org-1234567890",
    "name": "Acme Corporation",
    "externalId": "ACME-2024-001",
    "phone": "+1-555-123-4567",
    "employeeCount": 250,
    "annualRevenue": 50000000,
    "taxExemptStatus": "none",
    "creationSource": "api",
    "creationState": "active",
    "website": "https://www.acmecorp.com",
    "billingAddress": {
      "line1": "123 Business Rd",
      "city": "Metropolis",
      "state": "NY",
      "zipCode": "10001",
      "country": "USA",
      "line2": "Suite 400"
    },
    "metadata": {
      "industry": "Manufacturing",
      "accountManager": "jane.doe@acmecorp.com"
    }
  }
}

Creates a new order for a customer subscribing to a plan. The order will be created with the plan's products and pricing attributes.

Authentication

Path parameters

Query parameters

Response

Errors