Rebill

https://docs.rebill.com
Admin
Rebill is a payment processing platform that enables businesses to process payments in over 10...
Tokens:106,469
Snippets:866
Trust Score:8.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Rebill SDK

Source: https://docs.rebill.com/sdk/quickstart

Use npm to install the Rebill SDK package.

```bash
npm install rebill
```

--------------------------------

### Full checkout URL configuration example

Source: https://docs.rebill.com/products/checkout-landing

A comprehensive example combining customer data, language, coupons, and custom metadata.

```text
https://pay.rebill.com/{alias}/{payment-link-id}
  ?email=juan@example.com
  &firstName=Juan
  &lastName=Perez
  &phoneNumber=1123456789
  &countryCode=AR
  &language=es
  &addressStreet=Av+Corrientes+1234
  &addressCity=Buenos+Aires
  &addressState=Buenos+Aires
  &addressCountry=AR
  &addressZipCode=1043
  &couponCode=SUMMER20
  &utm_source=google
  &utm_campaign=summer2026
  &affiliate_id=AFF001
```

--------------------------------

### Subscription API Response Examples

Source: https://docs.rebill.com/api/reference/subscriptions

Examples of successful subscription retrieval and error handling for missing IDs.

```json
  {
    "id": "sub_ad128372a40b8dbac50a8ca20c7305b",
    "name": "Premium Plan",
    "description": "Premium subscription plan",
    "status": "active",
    "statusDetail": "active",
    "lastChargeDate": "2026-03-05T15:59:59.000Z",
    "nextChargeDate": "2026-04-05T15:59:59.000Z",
    "amount": 15000.00,
    "lastChargedAmount": 15000.00,
    "currency": "ARS",
    "setupFee": 0,
    "frequency": {
      "period": "month",
      "count": 1
    },
    "billingCycles": {
      "total": 12,
      "current": 1,
      "remaining": 11
    },
    "plan": {
      "id": "pln_647838573cf58d61bc659f6525f528ba",
      "title": "Premium Plan",
      "amount": 15000.00,
      "currency": "ARS",
      "frequency": {
        "period": "month",
        "quantity": 1
      },
      "repetitions": 12
    },
    "paymentMethod": "card",
    "card": {
      "id": "crd_647838573cf58d61bc659f6525f528ba",
      "brand": "visa",
      "type": "credit",
      "lastFourDigits": "4242"
    },
    "discount": {
      "couponCode": "DESC10",
      "type": "percentage",
      "percentage": 10,
      "billingCyclesToApply": {
        "total": 12,
        "remaining": 11
      }
    },
    "customer": {
      "id": "cus_647838573cf58d61bc659f6525f528ba",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "phone": "+1234567890"
    },
    "createdAt": "2026-03-05T15:59:59.000Z",
    "updatedAt": "2026-03-05T16:00:00.000Z",
    "metadata": {
      "customField": "value"
    }
  }
```

```json
  {
    "statusCode": 404,
    "message": "Subscription with id sub_xxx not found",
    "timestamp": "2026-04-18T14:27:06.135Z",
    "path": "/v3/subscriptions/sub_xxx",
    "method": "GET",
    "traceId": "exception_1745412426_x9k2m"
  }
```

--------------------------------

### Public API Key Example

Source: https://docs.rebill.com/api/reference/authentication

Example of a public key used for client-side environments.

```text
pk_50a6bfb37f474fa2995c32f21ee13d1c
```

--------------------------------

### Payment API Response Examples

Source: https://docs.rebill.com/api/reference/payments

Examples of successful and error responses for the Get payment by ID endpoint.

```json
  {
    "id": "pay_d03f9b0c037f44e99107210bc39184fd",
    "createdAt": "2025-05-15T16:56:06.603Z",
    "updatedAt": "2025-05-15T16:56:06.603Z",
    "organizationId": "org_8fa0d70f8ab54c7d8e54bc356422b2bd",
    "amount": 10000,
    "currency": "ARS",
    "customer": {
      "id": "cus_08d93677c7ca45abbea1a0dc21b85aed",
      "email": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "defaultLanguage": "es",
      "phone": "+5491123456789"
    },
    "status": "approved",
    "metadata": null,
    "paymentMethodType": "card",
    "card": {
      "id": "crd_99b867433c3c46759ad14f5ae9046894",
      "brand": "visa",
      "type": "credit",
      "lastFourDigits": "1111",
      "name": "John Doe"
    },
    "quantity": 1,
    "installments": null,
    "couponId": null,
    "description": "Premium Plan",
    "discount": null,
    "processingMode": "local",
    "fees": [
      {
        "id": "fea_c789a4b21c3b4e4f85f1a4e6fd28b4c1",
        "feeRuleId": "fee_d01e2a55cb314d52bdb4f8a6e1a89f04",
        "amount": 5.0,
        "currency": "USD",
        "description": "Service fee",
        "percentageAmount": 5.0,
        "fixedAmount": 0,
        "type": "financing"
      }
    ],
    "taxes": [
      {
        "id": "txa_c78996a53e52432586a7bb81d7c9e1f2",
        "taxRuleId": "txr_d01abf83eab8471f970fb1c2efc6a8d9",
        "amount": 0.50,
        "currency": "USD",
        "description": "Tax on service fee",
        "percentageAmount": 10,
        "fixedAmount": 0,
        "feeAppliedId": "fea_c789a4b21c3b4e4f85f1a4e6fd28b4c1",
        "name": "VAT"
      }
    ],
    "sourceExchangeRate": 1,
    "netAmount": "95.00",
    "currencyNetAmount": "USD",
    "errorDetail": null,
    "errorType": null,
    "isProviderError": false,
    "subscriptionId": null,
    "country": "US",
    "timezone": "America/New_York",
    "traceId": "aB1745412426000",
    "type": "one_time_payment",
    "origin": "api",
    "oneClick": false
  }
```

```json
  {
    "statusCode": 401,
    "message": "Invalid API key",
    "timestamp": "2026-04-18T14:27:06.135Z",
    "path": "/v3/payments/pay_xxx",
    "method": "GET",
    "traceId": "exception_1745412426_x9k2m"
  }
```

```json
  {
    "statusCode": 404,
    "message": "Payment with id pay_xxx not found",
    "timestamp": "2026-04-18T14:27:06.135Z",
    "path": "/v3/payments/pay_xxx",
    "method": "GET",
    "traceId": "exception_1745412426_x9k2m"
  }
```

--------------------------------

### Webhook Signature Header Example

Source: https://docs.rebill.com/guides/webhooks

Example of the x-rebill-signature header format.

```text
x-rebill-signature: 8f2b1d0c4a7e963f5b8c2d1a0e4f7b3c6d9a2e5f8b1c4d7a0e3f6b9c2d5a8e1f
```

--------------------------------

### Subscription Payment Response Examples

Source: https://docs.rebill.com/api/reference/subscriptions

Examples of JSON responses returned by the subscription payment endpoint for successful and error states.

```json
// Empty body
```

```json
  {
    "statusCode": 404,
    "message": "Subscription with id sub_xxx not found",
    "timestamp": "2026-04-18T14:27:06.135Z",
    "path": "/v3/subscriptions/sub_xxx/pay",
    "method": "POST",
    "traceId": "exception_1745412426_x9k2m"
  }
```

```json
  {
    "statusCode": 400,
    "message": "Cannot process payment for a cancelled subscription",
    "timestamp": "2026-04-18T14:27:06.135Z",
    "path": "/v3/subscriptions/sub_xxx/pay",
    "method": "POST",
    "traceId": "exception_1745412426_x9k2m"
  }
```

--------------------------------

### Start subscription with saved card

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Starts a subscription for an existing plan using a previously tokenized card ID. This method ensures no raw card data touches your servers.

```json
{
  "subscription": {
    "quantity": 1,
    "currency": "ARS",
    "planId": "pln_3724ff11fa5c4853bea5a22b2867191b"
  },
  "customer": {
    "firstName": "Ana",
    "lastName": "Lopez",
    "email": "ana@example.com"
  },
  "cardId": "crd_d16eb336861744e3aadc6d29874bd9a1"
}
```

--------------------------------

### 200 OK Response Example

Source: https://docs.rebill.com/api/reference/payments

Example of a successful response for a partially refunded payment, showing the structure of treasury transactions and net amounts.

```json
{
    "paymentId": "pay_d03f9b0c037f44e99107210bc39184fd",
    "status": "partially_refunded",
    "amount": 10000,
    "currency": "ARS",
    "settlementCurrency": "ARS",
    "net": {
      "amount": 3832,
      "grossAmount": 10000,
      "currency": "ARS",
      "isComplete": true,
      "hasPendingTransactions": false
    },
    "transactions": [
      {
        "id": "trx_6f2f4d9be29a4a969c2f2a3f1f0c1a11",
        "balanceEffect": "credit",
        "status": "approved"
```

--------------------------------

### FX Timeseries Response Examples

Source: https://docs.rebill.com/api/reference/fx

Examples of successful and error responses for the timeseries endpoint.

```json
{
  "success": true,
  "timeseries": true,
  "start_date": "2026-06-08",
  "end_date": "2026-06-10",
  "base": "USD",
  "rates": {
    "2026-06-08": { "ARS": 1175.00 },
    "2026-06-09": { "ARS": 1178.40 },
    "2026-06-10": { "ARS": 1180.25 }
  }
}
```

```json
{
  "statusCode": 404,
  "message": "No FX rates available for pair USD/ARS between 2026-06-08 and 2026-06-10"
}
```

--------------------------------

### Update address response example

Source: https://docs.rebill.com/api/reference/addresses

Example of the JSON response body returned after a successful address update.

```json
{
  "address": {
    "id": "addr_12aa31cdfb574e4191e96e67523a3560",
    "customerId": "cus_786176c9d39f40d8af98428edb2aa3db",
    "type": "billing",
    "country": "AR",
    "state": "Buenos Aires",
    "city": "Buenos Aires",
    "zipCode": "1043",
    "lineOne": "Av. Cordoba 5678",
    "lineTwo": "Office 12"
  }
}
```

--------------------------------

### Get Latest FX Rate Response

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Example JSON response for the latest exchange rate of a currency pair.

```json
{
  "success": true,
  "timestamp": 1718323200,
  "date": "2026-06-24T00:00:00.000Z",
  "base": "USD",
  "rates": { "ARS": 1234.56 }
}
```

--------------------------------

### GET /products/{id}

Source: https://docs.rebill.com/api/reference/products

Fetches a single product with all its prices.

```APIDOC
## GET /products/{id}

### Description
Fetches a single product with all its prices.

### Method
GET

### Endpoint
/products/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The product ID. Prefixed with `prd_`.

### Response
#### Success Response (200)
- **product object** (object) - The requested product details.

### Errors
- **401 Unauthorized**: Missing or invalid `x-api-key`.
- **404 Not Found**: No product with that ID exists in your organization.
```

--------------------------------

### Payment Link API Response Examples

Source: https://docs.rebill.com/api/reference/payment-links

Examples of successful and error responses returned when fetching a payment link by ID.

```json
  {
    "id": "pl_61bf3f7342d94a92affbad75637211ad",
    "organizationId": "org_a2a2627fe8444c64be3b6ece42d973c4",
    "url": "https://pay.rebill.com/acme/pl_61bf3f7342d94a92affbad75637211ad",
    "status": "active",
    "title": [{ "text": "Annual Pass", "language": "en" }],
    "description": null,
    "metadata": null,
    "isSingleUse": false,
    "expirationDate": null,
    "redirectUrls": {
      "approved": "https://example.com/success"
    },
    "prefilledFields": null,
    "showCoupon": false,
    "createdAt": "2026-04-18T14:27:06.135Z",
    "updatedAt": "2026-04-18T14:27:06.135Z",
    "paymentMethods": [
      {
        "methods": ["card", "bank_transfer"],
        "currency": "ARS"
      }
    ],
    "installmentsSettings": [
      { "currency": "ARS", "enabledInstallments": [1, 3, 6, 12] }
    ],
    "prices": [
      {
        "id": "plp_2becf73d76244625bccca2c7b710f268",
        "amount": 15000.00,
        "currency": "ARS",
        "isPriceFixed": false,
        "isDefault": true
      }
    ],
    "type": "instant"
  }
```

```json
  {
    "statusCode": 404,
    "message": "Payment link with id pl_xxx not found",
    "timestamp": "2026-04-18T14:27:06.135Z",
    "path": "/v3/payment-links/pl_xxx",
    "method": "GET",
    "traceId": "exception_1745412426_x9k2m"
  }
```

```json
  {
    "statusCode": 401,
    "message": "Invalid API key",
    "timestamp": "2026-04-18T14:27:06.135Z",
    "path": "/v3/payment-links/pl_xxx",
    "method": "GET",
    "traceId": "exception_1745412426_x9k2m"
  }
```

--------------------------------

### Product Payment Link Attributes

Source: https://docs.rebill.com/api/reference/payment-links

Example of a payment link configured for a specific product.

```json
  {
    "id": "pl_3b09c4a81c014da5a6e0337096196e33",
    "organizationId": "org_65c1e3dc26af42c09f7139ae45932496",
    "url": "https://pay.rebill.com/acme/pl_3b09c4a81c014da5a6e0337096196e33",
    "status": "active",
    "title": [
      { "text": "Mate Thermos", "language": "en" }
    ],
    "description": [
      { "text": "Contigo brand, pink", "language": "en" }
    ],
    "metadata": null,
    "isSingleUse": false,
    "expirationDate": null,
    "redirectUrls": {
      "approved": "https://example.com/success"
    },
    "prefilledFields": null,
    "showCoupon": false,
    "createdAt": "2026-04-02T22:01:09.514Z",
    "updatedAt": "2026-04-02T22:01:09.514Z",
    "paymentMethods": [
      {
        "methods": ["card", "bank_transfer"],
        "currency": "ARS"
      }
    ],
    "installmentsSettings": null,
    "prices": [],
    "type": "product",
    "product": {
      "id": "prd_e6d794609b5047cdaf4533916a5fab93",
      "name": [
        { "text": "Mate Thermos", "language": "en" }
      ],
      "description": [
        { "text": "Contigo brand, pink", "language": "en" }
      ],
      "status": "active",
      "metadata": null,
      "createdAt": "2026-04-02T22:01:09.332Z"
    }
  }
```

--------------------------------

### GET /customers

Source: https://docs.rebill.com/api/reference/customers

Returns a list of customers in creation order using cursor-based pagination.

```APIDOC
## GET /customers

### Description
Returns customers in creation order with cursor-based pagination. Iterate through the full list for sync jobs, exports, or reconciliation.

### Method
GET

### Endpoint
/customers

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Records per page. Defaults to 10. Max 100.
- **starting_after** (string) - Optional - Customer ID to start after (exclusive).
- **ending_before** (string) - Optional - Customer ID to end before (exclusive).

### Response
#### Success Response (200)
- **object** (string) - The type of object returned (list).
- **data** (array) - List of customer objects.
- **has_more** (boolean) - Indicates if there are more pages available.
- **url** (string) - The endpoint URL.

### Errors
- **401 Unauthorized** - Missing or invalid `x-api-key`.
```

--------------------------------

### GET /products/:productId

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Retrieves the details of a specific product by its unique identifier.

```APIDOC
## GET /products/:productId

### Description
Fetches a single product with all its prices. Returns 404 if the product does not exist.

### Method
GET

### Endpoint
{{base_url}}/products/:productId

### Parameters
#### Path Parameters
- **productId** (string) - Required - The unique identifier of the product, prefixed with 'prd_'.
```

--------------------------------

### Checkout Response Examples

Source: https://docs.rebill.com/api/reference/checkout

JSON response structures for successful and declined checkout attempts.

```json
{
  "traceId": "checkout_1709058830240_kj8n2x5",
  "date": "2026-04-19T14:22:10.000Z",
  "result": {
    "paymentId": "pay_987f8a061d2c3da6ab044711e51f163d",
    "status": "approved",
    "subscriptionId": "sub_3k1568576a364e10aa96a149c753093",
    "cardId": "crd_251568576a364e10aa96a149c753krut",
    "cardLastFour": "6467",
    "customerId": "cus_327f8a061d2c3da6ab044711e510sder"
  }
}
```

```json
{
  "traceId": "checkout_1709058830240_kj8n2x5",
  "date": "2026-04-19T14:22:10.000Z",
  "error": {
    "message": "rejected",
    "type": "insufficient_funds",
    "rawMessage": "The card has insufficient funds to complete this transaction"
  }
}
```

--------------------------------

### Get Webhook by ID Responses

Source: https://docs.rebill.com/api/reference/webhooks

Examples of successful and error responses when retrieving a webhook by its identifier.

```json
{
  "id": "we_f2b90261588e45edaf93c488e577ac66",
  "url": "https://hook.us1.make.com/1gh9w22g24qdrvll62n0ed7x6z3h53n4",
  "active": true,
  "events": [
    "payment.created"
  ],
  "organizationId": "org_8fa0d70f8ab54c7d8e54bc356422b2bd"
}
```

```json
{
  "statusCode": 404,
  "message": "Webhook with id we_xxx not found",
  "timestamp": "2026-04-18T14:27:06.135Z",
  "path": "/v3/webhooks/we_xxx",
  "method": "GET",
  "traceId": "exception_1745412426_x9k2m"
}
```

--------------------------------

### Create a product

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Creates a new product with at least one price. Amounts should be provided as decimals in the currency's major unit.

```json
{
  "name": [
    { "language": "es", "text": "Curso online de finanzas" },
    { "language": "en", "text": "Online finance course" }
  ],
  "description": [
    { "language": "es", "text": "12 módulos, acceso de por vida" }
  ],
  "prices": [
    { "amount": 99.99, "currency": "USD", "isDefault": true },
    { "amount": 2500.00, "currency": "ARS" }
  ],
  "metadata": { "sku": "FINANCE-101" }
}
```

--------------------------------

### Get Historical Rate Response

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Example JSON response for an exchange rate on a specific past date.

```json
{
  "success": true,
  "historical": true,
  "date": "2026-06-10",
  "base": "USD",
  "timestamp": 1717977600,
  "rates": { "ARS": 1180.25 }
}
```

--------------------------------

### POST /products

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Creates a new product in the system with associated pricing and metadata.

```APIDOC
## POST /products

### Description
Creates a product with at least one price. Amounts should be provided as decimals in the currency's major unit.

### Method
POST

### Endpoint
{{base_url}}/products

### Request Body
- **name** (array) - Required - Array of { language, text } objects.
- **prices** (array) - Required - Array of { amount, currency, isDefault } objects.
- **status** (string) - Optional - 'active' or 'draft'.
- **metadata** (object) - Optional - Custom key-value pairs.

### Request Example
{
  "name": [
    { "language": "es", "text": "Curso online de finanzas" },
    { "language": "en", "text": "Online finance course" }
  ],
  "description": [
    { "language": "es", "text": "12 módulos, acceso de por vida" }
  ],
  "prices": [
    { "amount": 99.99, "currency": "USD", "isDefault": true },
    { "amount": 2500.00, "currency": "ARS" }
  ],
  "metadata": { "sku": "FINANCE-101" }
}
```

--------------------------------

### Get spot rate responses

Source: https://docs.rebill.com/api/reference/fx

Provides the latest exchange rate for a currency pair. Includes both a successful rate retrieval and a 404 error example.

```json
{
  "success": true,
  "timestamp": 1718323200,
  "date": "2026-06-24T00:00:00.000Z",
  "base": "USD",
  "rates": { "ARS": 1234.56 }
}
```

```json
{
  "statusCode": 404,
  "message": "No FX rate available for pair USD/ARS"
}
```

--------------------------------

### Product Object JSON Structure

Source: https://docs.rebill.com/api/reference/products

Example of a fully populated product object including localized names, descriptions, multiple currency prices, and metadata.

```json
{
  "id": "prd_c5718bae2e5545ecae2e396a796570f5",
  "name": [
    { "language": "es", "text": "Curso online de finanzas" },
    { "language": "en", "text": "Online finance course" }
  ],
  "description": [
    { "language": "es", "text": "12 módulos, acceso de por vida" }
  ],
  "status": "active",
  "prices": [
    {
      "id": "prp_276128e0b490451fabd215ea0e10e718",
      "amount": 99.99,
      "currency": "USD",
      "isDefault": true,
      "createdAt": "2026-04-10T12:00:00.000Z",
      "updatedAt": "2026-04-10T12:00:00.000Z"
    },
    {
      "id": "prp_beb31ffe62254e54b06b58e84f6a5400",
      "amount": 2500.00,
      "currency": "ARS",
      "isDefault": false,
      "createdAt": "2026-04-10T12:00:00.000Z",
      "updatedAt": "2026-04-10T12:00:00.000Z"
    }
  ],
  "metadata": { "sku": "FINANCE-101" },
  "createdAt": "2026-04-10T12:00:00.000Z",
  "updatedAt": "2026-04-10T12:00:00.000Z"
}
```

--------------------------------

### Create Product Payment Link

Source: https://docs.rebill.com/api/reference/payment-links

Generates a payment link for a specific product with quantity configuration.

```bash
curl -X POST https://api.rebill.com/v3/payment-links \
-H "x-api-key: {{API_KEY}}" \
-H "content-type: application/json" \
-d '{
"title": [{ "text": "Mate Thermos", "language": "en" }],
"description": [{ "text": "Contigo brand, pink", "language": "en" }],
"paymentMethods": [
{ "methods": ["card", "bank_transfer"], "currency": "ARS" }
],
"product": {
"id": "prd_e6d794609b5047cdaf4533916a5fab93",
"quantity": 1,
"isQuantityEditable": true
},
"redirectUrls": {
"approved": "https://example.com/success"
}
}'
```

--------------------------------

### POST /products

Source: https://docs.rebill.com/api/reference/products

Creates a new product in the system. Requires at least one price and localized name entries.

```APIDOC
## POST /products

### Description
Creates a product with at least one price. Rebill flags the first price as `isDefault: true` when no entry sets the flag. Multiple defaults in the same request are rejected.

### Method
POST

### Endpoint
/products

### Request Body
- **name** (array) - Required - At least one `{ language, text }` entry. `language` is `en`, `es`, or `pt`.
- **description** (array) - Optional - Same shape as `name`.
- **status** (string) - Optional - `active` or `draft`. Defaults to `active`.
- **prices** (array) - Required - At least one price object containing `amount` (number), `currency` (string), and `isDefault` (boolean).
- **metadata** (object) - Optional - Free-form key-value map.

### Response
#### Success Response (201)
- **product** (object) - Returns the created product object.

#### Error Responses
- **400 Bad Request** - Validation failed (e.g., multiple defaults, duplicate languages, invalid currency).
- **400 Bad Request** - Missing required field (name or prices).
- **401 Unauthorized** - Missing or invalid `x-api-key`.
```

--------------------------------

### Configure dynamic pricing for instant checkout

Source: https://docs.rebill.com/sdk/instant-checkout

Computes the product amount based on user selections and serializes the object to the instant-product attribute. Ensure this is set before component initialization.

```javascript
import 'rebill'

function buildInstantProduct(selections) {
  const basePrice = 19.90
  const addons = selections.includes('priority-support') ? 5.00 : 0
  const total = basePrice + addons
  return {
    name: [{ language: 'en', text: 'Custom Package' }],
    description: [{ language: 'en', text: `Includes: ${selections.join(', ')}` }],
    amount: Number(total.toFixed(2)),
    currency: 'USD',
    metadata: { selections: selections.join(',') }
  }
}

const el = document.querySelector('rebill-checkout')
el.setAttribute('instant-product', JSON.stringify(buildInstantProduct(['priority-support'])))
```

--------------------------------

### Create Instant Payment Link

Source: https://docs.rebill.com/api/reference/payment-links

Generates a one-time payment link with specific price and installment settings.

```bash
curl -X POST https://api.rebill.com/v3/payment-links \
-H "x-api-key: {{API_KEY}}" \
-H "content-type: application/json" \
-d '{
"title": [{ "text": "Annual Pass", "language": "en" }],
"paymentMethods": [
{ "methods": ["card", "bank_transfer"], "currency": "ARS" }
],
"prices": [
{ "amount": 15000.00, "currency": "ARS", "isDefault": true }
],
"installmentsSettings": [
{ "currency": "ARS", "enabledInstallments": [1, 3, 6, 12] }
],
"isSingleUse": false,
"redirectUrls": {
"approved": "https://example.com/success"
}
}'
```

--------------------------------

### Secret API Key Example

Source: https://docs.rebill.com/api/reference/authentication

Example of a secret key used for server-side operations.

```text
sk_ea1db6a164bb4fd6bb208d0b86655657
```

--------------------------------

### Webhook Rotation Response Examples

Source: https://docs.rebill.com/api/reference/webhooks

Examples of successful and error responses when rotating a webhook signing secret.

```json
{
  "id": "we_f2b90261588e45edaf93c488e577ac66",
  "url": "https://hook.us1.make.com/1gh9w22g24qdrvll62n0ed7x6z3h53n4",
  "active": true,
  "events": [
    "payment.created"
  ],
  "organizationId": "org_8fa0d70f8ab54c7d8e54bc356422b2bd",
  "signingSecret": "whsec_2e9d4c1b7a0f36582d4e1c9b0a7f5e3d6c2b8a4f1e0d9c7b5a3f2e1d0c9b8a7f"
}
```

```json
{
  "statusCode": 404,
  "message": "Webhook not found",
  "timestamp": "2026-04-18T14:27:06.135Z",
  "path": "/v3/webhooks/we_xxx/rotate",
  "method": "POST",
  "traceId": "exception_1745412426_x9k2m"
}
```

--------------------------------

### Environment Variable Configuration

Source: https://docs.rebill.com/api/reference/authentication

Recommended format for storing API keys in a .env file.

```bash
# .env
REBILL_SECRET_KEY=sk_ea1db6a164bb4fd6bb208d0b86655657
```

--------------------------------

### POST /plans

Source: https://docs.rebill.com/api/reference/plans

Creates a new subscription plan with specified pricing, billing frequency, and optional trial or debit settings.

```APIDOC
## POST /plans

### Description
Creates a plan with at least one price. Rebill automatically flags the first price as `isDefault: true` if you don't set the flag on any entry.

### Method
POST

### Endpoint
/plans

### Parameters
#### Request Body
- **name** (object) - Required - At least one `{ language, text }` entry.
- **frequency** (object) - Required - `{ period, count }`. `period` must be `month` or `year`.
- **billingCycles** (integer) - Optional - Total billing cycles. Minimum 2.
- **trialPeriodDays** (integer) - Optional - Free trial length in days. Cannot be combined with `debitDay`.
- **debitDay** (integer) - Optional - Fixed day of the month (1-28) to charge. Cannot be combined with `trialPeriodDays`.
- **debitStrategy** (string) - Optional - Required when `debitDay` is set. One of: `charge_full`, `charge_next_cycle`, `charge_prorated`.
- **status** (string) - Optional - `active` or `draft`. Defaults to `active`.
- **prices** (array) - Required - At least one price object containing `amount` (number), `currency` (string), `isDefault` (boolean), and `initialFee` (number).
- **metadata** (object) - Optional - Free-form key-value map.

### Response
#### Success Response (201)
- **plan** (object) - The created plan object.
```

--------------------------------

### POST /plans

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Creates a new plan with specified frequency, pricing, and metadata.

```APIDOC
## POST /plans

### Description
Creates a new plan in the system.

### Method
POST

### Endpoint
{{base_url}}/plans

### Request Body
- **name** (array) - Required - List of language-specific names.
- **description** (array) - Optional - List of language-specific descriptions.
- **frequency** (object) - Required - Billing cycle configuration.
- **debitDay** (number) - Optional - Day of the month for debit.
- **debitStrategy** (string) - Optional - Strategy for debiting.
- **prices** (array) - Required - List of price objects.
- **metadata** (object) - Optional - Custom metadata.
```

--------------------------------

### Payment Link API Response Examples

Source: https://docs.rebill.com/api/reference/payment-links

Examples of successful and error response payloads returned by the Payment Links API.

```json
{
    "id": "pl_db5f9e188a7c498e800e95d2330e261b",
    "organizationId": "org_a2a2627fe8444c64be3b6ece42d973c4",
    "url": "https://pay.rebill.com/acme/pl_db5f9e188a7c498e800e95d2330e261b",
    "status": "active",
    "title": [{ "text": "Annual Pass - Extended", "language": "en" }],
    "description": null,
    "metadata": {
      "campaign": "q2_2026",
      "reviewed_by": "finance"
    },
    "isSingleUse": false,
    "expirationDate": "2026-12-31T23:59:59.000Z",
    "redirectUrls": {
      "approved": "https://example.com/success",
      "rejected": "https://example.com/failed"
    },
    "prefilledFields": null,
    "showCoupon": true,
    "createdAt": "2026-04-07T21:27:12.409Z",
    "updatedAt": "2026-04-18T14:35:31.546Z",
    "paymentMethods": [
      { "methods": ["card", "bank_transfer"], "currency": "ARS" }
    ],
    "installmentsSettings": [
      { "currency": "ARS", "enabledInstallments": [1, 3, 6, 12] }
    ],
    "prices": [
      {
        "id": "plp_8ff3a5c1e9b8441a9c3e5f2d6a4b7c85",
        "amount": 18000.00,
        "currency": "ARS",
        "isPriceFixed": false,
        "isDefault": true
      }
    ],
    "type": "instant"
  }
```

```json
{
    "statusCode": 404,
    "message": "Payment link with id pl_xxx not found",
    "timestamp": "2026-04-18T14:27:06.135Z",
    "path": "/v3/payment-links/pl_xxx",
    "method": "PATCH",
    "traceId": "exception_1745412426_x9k2m"
  }
```

```json
{
    "statusCode": 400,
    "message": "Payment method cash is not enabled for currency ARS",
    "timestamp": "2026-04-18T14:27:06.135Z",
    "path": "/v3/payment-links/pl_xxx",
    "method": "PATCH",
    "traceId": "exception_1745412426_x9k2m"
  }
```

```json
{
    "statusCode": 401,
    "message": "Invalid API key",
    "timestamp": "2026-04-18T14:27:06.135Z",
    "path": "/v3/payment-links/pl_xxx",
    "method": "PATCH",
    "traceId": "exception_1745412426_x9k2m"
  }
```

--------------------------------

### Create Subscription Payment Link

Source: https://docs.rebill.com/api/reference/payment-links

Generates a payment link linked to a specific subscription plan.

```bash
curl -X POST https://api.rebill.com/v3/payment-links \
-H "x-api-key: {{API_KEY}}" \
-H "content-type: application/json" \
-d '{
"title": [{ "text": "Premium Subscription", "language": "en" }],
"description": [{ "text": "Monthly access to premium content", "language": "en" }],
"paymentMethods": [
{ "methods": ["card", "bank_transfer"], "currency": "ARS" }
],
"plan": {
"id": "pln_7b60d18b54c84e1dbb875741a367210c"
},
"showCoupon": true,
"redirectUrls": {
"approved": "https://example.com/success"
}
}'
```

--------------------------------

### Example subscription.updated payload for card change

Source: https://docs.rebill.com/guides/webhooks

A sample JSON payload showing a subscription update where the card has been changed.

```json
{
  "id": "sub_1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d",
  "organization": { "id": "org_3f662e66b5f24b548f59331aa89b4fbf" },
  "status": "active",
  "lastStatus": "active",
  "statusDetail": null,
  "lastStatusDetail": null,
  "cardUpdated": true,
  "card": { "id": "crd_9e8d7c6b5a4938271605f4e3d2c1b0a9", "brand": "visa", "lastFourDigits": "4242" }
}
```

--------------------------------

### Import Rebill SDK

Source: https://docs.rebill.com/sdk/quickstart

Import the SDK in your main project file to enable the checkout component.

```javascript
import 'rebill';
```

--------------------------------

### GET /addresses/:addressId

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Fetches a single address by ID.

```APIDOC
## GET /addresses/:addressId

### Description
Fetches a single address by ID.

### Method
GET

### Endpoint
/addresses/:addressId

### Parameters
#### Path Parameters
- **addressId** (string) - Required - Address ID, prefixed with addr_
```

--------------------------------

### Pre-fill customer data via URL parameters

Source: https://docs.rebill.com/products/checkout-landing

Use query parameters to populate checkout fields with customer information, rendering them as read-only labels.

```text
https://pay.rebill.com/{alias}/{payment-link-id}?email=juan@example.com&firstName=Juan&lastName=Perez&phoneNumber=1123456789&countryCode=AR&addressStreet=Av+Corrientes+1234&addressCity=Buenos+Aires&addressState=Buenos+Aires&addressCountry=AR&addressZipCode=1043
```

--------------------------------

### GET /members

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Returns a paginated list of team members in the organization.

```APIDOC
## GET /members

### Description
Returns a paginated list of team members in the organization. Filter by role, status, name, or email.

### Method
GET

### Endpoint
{{base_url}}/members

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of results to return.
- **offset** (integer) - Optional - Number of results to skip.
```

--------------------------------

### GET /webhooks/:id

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Retrieves details of a specific webhook configuration.

```APIDOC
## GET /webhooks/:id

### Description
Returns the webhook: `id`, `url`, `active`, subscribed `events`, and `organizationId`.

### Method
GET

### Endpoint
/webhooks/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The webhook ID.
```

--------------------------------

### Create Address Response

Source: https://docs.rebill.com/api/reference/addresses

Example of the successful response body returned when creating a new address.

```json
{
  "address": {
    "id": "addr_12aa31cdfb574e4191e96e67523a3560",
    "customerId": "cus_786176c9d39f40d8af98428edb2aa3db",
    "type": "billing",
    "country": "AR",
    "state": "Buenos Aires",
    "city": "Buenos Aires",
    "zipCode": "1043",
    "lineOne": "Av. Corrientes 1234",
    "lineTwo": "Piso 5, Depto A"
  }
}
```

--------------------------------

### GET /coupons/:couponId

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Fetches a single coupon by its unique identifier.

```APIDOC
## GET /coupons/:couponId

### Description
Fetches a single coupon by ID. Returns 400 Bad Request if the coupon does not exist.

### Method
GET

### Endpoint
{{base_url}}/coupons/:couponId

### Parameters
#### Path Parameters
- **couponId** (string) - Required - Coupon ID, prefixed with cpn_

### Response
#### Success Response (200)
- **Body** - The coupon object
```

--------------------------------

### Instant Payment Link Attributes

Source: https://docs.rebill.com/api/reference/payment-links

Example of a payment link configured for an instant, one-time payment.

```json
  {
    "id": "pl_61bf3f7342d94a92affbad75637211ad",
    "organizationId": "org_a2a2627fe8444c64be3b6ece42d973c4",
    "url": "https://pay.rebill.com/acme/pl_61bf3f7342d94a92affbad75637211ad",
    "status": "active",
    "title": [
      { "text": "Annual Pass", "language": "en" }
    ],
    "description": [
      { "text": "Full access for 12 months", "language": "en" }
    ],
    "metadata": {
      "campaign": "black_friday_2026",
      "sku": "ANNUAL-001"
    },
    "isSingleUse": false,
    "expirationDate": "2026-12-31T23:59:59.000Z",
    "redirectUrls": {
      "pending": "https://example.com/pending",
      "approved": "https://example.com/success",
      "rejected": "https://example.com/failure"
    },
    "prefilledFields": {
      "customer": {
        "email": "ana@example.com",
        "fullName": "Ana Lopez",
        "phoneNumber": "1123456789",
        "countryCode": "+54",
        "language": "es"
      }
    },
    "showCoupon": false,
    "createdAt": "2026-04-15T00:27:06.135Z",
    "updatedAt": "2026-04-15T00:27:06.135Z",
    "paymentMethods": [
      {
        "methods": ["card", "bank_transfer"],
        "currency": "ARS"
      }
    ],
    "installmentsSettings": [
      { "currency": "ARS", "enabledInstallments": [1, 3, 6, 12] }
    ],
    "prices": [
      {
        "id": "plp_2becf73d76244625bccca2c7b710f268",
        "amount": 15000.00,
        "currency": "ARS",
        "isPriceFixed": true,
        "isDefault": true
      }
    ],
    "type": "instant"
  }
```

--------------------------------

### GET /customers/:customerId

Source: https://docs.rebill.com/rebill-api.postman_collection.json

Retrieves a specific customer and their related resources.

```APIDOC
## GET /customers/:customerId

### Description
Returns the customer and their related resources (addresses, identifications, cards).

### Method
GET

### Endpoint
{{base_url}}/customers/:customerId

### Parameters
#### Path Parameters
- **customerId** (string) - Required - Customer ID, prefixed with cus_
```
Tokens:
Raw