Logo

API Reference

SDK Support

For easier integration, consider using our official SDKs: @saazpayhq/node-sdk

Authentication

All API endpoints require authentication using a Bearer token. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Endpoints

Get Plans

Retrieve all available pricing plans for your application.

Endpoint: GET /plans

Query Parameters:

  • id (required): Your application ID

Example Request:

curl -X GET "https://saazpay.com/api/v1/plans?id={appId}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

[
  {
    "id": "plan_123",
    "price": 1000,
    "currency": "USD",
    "tax_mode": "account_setting",
    "name": "Basic Plan",
    "description": "A basic subscription plan",
    "billing_frequency": 1,
    "billing_interval": "month",
    "trial_frequency": null,
    "trial_interval": null,
    "quantity_minimum": 1,
    "quantity_maximum": 1,
    "product_id": "prod_123",
    "createdAt": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-01T00:00:00Z",
    "product": {
      "id": "prod_123",
      "name": "Basic Product",
      "description": "Basic product description"
    }
  }
]

Get Active Subscription

Retrieve the active subscription for a specific user.

Endpoint: GET /subscriptions

Query Parameters:

  • appId (required): Your application ID
  • userId (required): The unique identifier for the user

Example Request:

curl -X GET "https://saazpay.com/api/v1/subscriptions?appId={appId}&userId={user_unique_identifier}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "id": "sub_123",
  "customer_id": "cus_123",
  "unique_identifier": "[email protected]",
  "status": "active",
  "paused_at": null,
  "canceled_at": null,
  "scheduled_change": null,
  "next_billed_at": "2023-02-01T00:00:00Z",
  "starts_at": "2023-01-01T00:00:00Z",
  "ends_at": "2023-02-01T00:00:00Z",
  "created_at": "2023-01-01T00:00:00Z",
  "applicationId": "app_123",
  "product": {
    "id": "prod_123",
    "name": "Basic Product",
    "description": "Basic product description"
  },
  "price": {
    "id": "price_123",
    "amount": 1000,
    "currency": "USD"
  }
}

Note: Returns null if no active subscription is found for the user.

Get Management URLs

Retrieve management URLs for a specific subscription.

Endpoint: GET /subscriptions/management

Query Parameters:

  • appId (required): Your application ID
  • subscriptionId (required): The subscription ID

Example Request:

curl -X GET "https://saazpay.com/api/v1/subscriptions/management?appId={appId}&subscriptionId={subscriptionId}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "customerPortal": "https://checkout.paddle.com/customer/portal/...",
  "cancelSubscription": "https://checkout.paddle.com/cancel/...",
  "updatePaymentMethod": "https://checkout.paddle.com/update/..."
}

Preview Plan Change

Preview the changes and costs when switching to a new plan.

Endpoint: GET /subscriptions/management/preview-plan

Query Parameters:

  • appId (required): Your application ID
  • subscriptionId (required): The subscription ID
  • newPlanId (required): The new plan ID to preview

Example Request:

curl -X GET "https://saazpay.com/api/v1/subscriptions/management/preview-plan?appId={appId}&subscriptionId={subscriptionId}&newPlanId={newPlanId}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "currencyCode": "USD",
  "proratedCharge": 500,
  "creditAmount": 300,
  "subTotal": 1500,
  "tax": 150,
  "discount": 0,
  "creditApplied": 300,
  "grandTotal": 1350
}

Change Plan

Change the subscription to a new plan.

Endpoint: PUT /subscriptions/management/change-plan

Query Parameters:

  • appId (required): Your application ID
  • subscriptionId (required): The subscription ID
  • newPlanId (required): The new plan ID to change to

Example Request:

curl -X PUT "https://saazpay.com/api/v1/subscriptions/management/change-plan?appId={appId}&subscriptionId={subscriptionId}&newPlanId={newPlanId}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "id": "sub_123",
  "status": "active"
}

Integration

Previous Page

Support

Next Page

On this page