RevenueCat API v1

https://www.revenuecat.com/docs/api-v1
Admin
RevenueCat is a REST API platform that enables developers to manage subscriptions, process...
Tokens:41,456
Snippets:190
Trust Score:10
Update:3 days ago
Show doc for...
Tokens:
Raw
### Get Authenticated Customer Virtual Currencies Response

Source: https://www.revenuecat.com/docs/api-v1/customers.md

Example JSON response showing the structure of virtual currency balances for an authenticated customer.

```json
{
  "virtual_currencies": {
    "property1": {
      "balance": 100,
      "name": "Gold",
      "code": "GLD",
      "description": "Premium currency"
    },
    "property2": {
      "balance": 100,
      "name": "Gold",
      "code": "GLD",
      "description": "Premium currency"
    }
  }
}
```

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

### Grant Promotional Entitlement Request Body

Source: https://www.revenuecat.com/docs/api-v1/entitlements.md

Example JSON payload for granting a promotional entitlement using start and end timestamps.

```json
{
  "start_time_ms": 1709195668093,
  "end_time_ms": 1709196532093
}
```

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

### GET /customer/offerings

Source: https://www.revenuecat.com/docs/api-v1/offerings.md

Gets the offerings for the Customer identified by the access token. Requires an authentication access token.

```APIDOC
## GET /customer/offerings

### Description
Gets the offerings for the Customer identified by the access token. Returns the same response as Get Offerings. Requires an Authentication access token.

### Method
GET

### Endpoint
https://api.revenuecat.com/v1/customer/offerings

### Authorizations
- AccessToken

### Responses

#### Success Response (200)
Returns the Offerings for the Customer.

#### Response Example
{
  "value": {
    "current_offering_id": "default",
    "offerings": [
      {
        "description": "The default offering",
        "identifier": "default",
        "packages": [
          {
            "identifier": "$rc_monthly",
            "platform_product_identifier": "monthly_free_trial"
          },
          {
            "identifier": "consumable",
            "platform_product_identifier": "consumable1"
          },
          {
            "identifier": "$rc_annual",
            "platform_product_identifier": "yearly_free_trial"
          }
        ]
      },
      {
        "description": "The sale offeringg",
        "identifier": "sale_offering",
        "packages": [
          {
            "identifier": "$rc_monthly",
            "platform_product_identifier": "monthly_free_trial_sale"
          },
          {
            "identifier": "consumable",
            "platform_product_identifier": "consumable1_sale"
          },
          {
            "identifier": "$rc_annual",
            "platform_product_identifier": "yearly_free_trial_sale"
          }
        ]
      }
    ]
  }
}

#### Error Response (401)
The access token is missing, invalid, or expired.
```

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

### Offerings Model JSON Example

Source: https://www.revenuecat.com/docs/api-v1/offerings-model.md

Example JSON response showing the Offerings Model schema with current_offering_id and two offerings (default and sale_offering), each containing packages with identifiers and platform product identifiers.

```json
{
  "current_offering_id": "default",
  "offerings": [
    {
      "description": "The default offering",
      "identifier": "default",
      "packages": [
        {
          "identifier": "$rc_monthly",
          "platform_product_identifier": "monthly_free_trial"
        },
        {
          "identifier": "consumable",
          "platform_product_identifier": "consumable1"
        },
        {
          "identifier": "$rc_annual",
          "platform_product_identifier": "yearly_free_trial"
        }
      ]
    },
    {
      "description": "The sale offeringg",
      "identifier": "sale_offering",
      "packages": [
        {
          "identifier": "$rc_monthly",
          "platform_product_identifier": "monthly_free_trial_sale"
        },
        {
          "identifier": "consumable",
          "platform_product_identifier": "consumable1_sale"
        },
        {
          "identifier": "$rc_annual",
          "platform_product_identifier": "yearly_free_trial_sale"
        }
      ]
    }
  ]
}
```

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

### GET /subscribers/{app_user_id}

Source: https://www.revenuecat.com/docs/api-v1/customers.md

Get or create a customer. This endpoint retrieves the customer information for the given app user ID, creating the customer if it does not exist.

```APIDOC
## GET /subscribers/{app_user_id}

### Description
Get or create a customer. This endpoint retrieves the customer information for the given app user ID, creating the customer if it does not exist.

### Method
GET

### Endpoint
/subscribers/{app_user_id}

### Parameters
#### Path Parameters
- **app_user_id** (string) - Required - The application user ID of the customer.

```

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

### Example POST Request Payload

Source: https://www.revenuecat.com/docs/api-v1

JSON body structure for POST requests, including the app_user_id and fetch_token.

```json
{
  "app_user_id": "user-1456",
  "fetch_token": "MQABC...EFH1234="
}
```

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

### Grant Promotional Entitlement Response

Source: https://www.revenuecat.com/docs/api-v1/entitlements.md

Example JSON response returned after successfully granting a promotional entitlement, containing the updated customer information.

```json
{
  "value": {
    "request_date": "2019-07-26T17:40:10Z",
    "request_date_ms": 1564162810884,
    "subscriber": {
      "entitlements": {
        "pro_cat": {
          "expires_date": null,
          "grace_period_expires_date": null,
          "product_identifier": "onetime",
          "purchase_date": "2019-04-05T21:52:45Z"
        }
      },
      "first_seen": "2019-02-21T00:08:41Z",
      "management_url": "https://apps.apple.com/account/subscriptions",
      "non_subscriptions": {
        "onetime": [
          {
            "id": "cadba0c81b",
            "is_sandbox": true,
            "purchase_date": "2019-04-05T21:52:45Z",
            "store": "app_store"
          }
        ]
      },
      "original_app_user_id": "XXX-XXXXX-XXXXX-XX",
      "original_application_version": "1.0",
      "original_purchase_date": "2019-01-30T23:54:10Z",
      "other_purchases": { },
      "subscriptions": {
        "annual": {
          "auto_resume_date": null,
          "billing_issues_detected_at": null,
          "expires_date": "2019-08-14T21:07:40Z",
          "grace_period_expires_date": null,
          "is_sandbox": true,
          "original_purchase_date": "2019-02-21T00:42:05Z",
          "ownership_type": "PURCHASED",
          "period_type": "normal",
          "purchase_date": "2019-07-14T20:07:40Z",
          "refunded_at": null,
          "store": "play_store",
          "store_transaction_id": "GPA.6801-7988-0152-76034..5",
          "unsubscribe_detected_at": "2019-07-17T22:48:38Z"
        },
        "onemonth": {
          "auto_resume_date": null,
          "billing_issues_detected_at": null,
          "expires_date": "2019-06-17T22:47:55Z",
          "grace_period_expires_date": null,
          "is_sandbox": true,
          "original_purchase_date": "2019-02-21T00:42:05Z",
          "ownership_type": "PURCHASED",
          "period_type": "normal",
          "purchase_date": "2019-06-17T22:42:55Z",
          "refunded_at": null,
          "store": "app_store",
          "store_transaction_id": 1000000652379790,
          "unsubscribe_detected_at": "2019-06-17T22:48:38Z"
        },
        "rc_promo_pro_cat_monthly": {
          "auto_resume_date": null,
          "billing_issues_detected_at": null,
          "expires_date": "2019-08-26T01:02:16Z",
          "grace_period_expires_date": null,
          "is_sandbox": false,
          "original_purchase_date": "2019-07-26T01:02:16Z",
          "ownership_type": "FAMILY_SHARED",
          "period_type": "normal",
          "purchase_date": "2019-07-26T01:02:16Z",
          "refunded_at": null,
          "store": "promotional",
          "store_transaction_id": "a42db3af39530cb82b17eaf9c6576393",
          "unsubscribe_detected_at": null
        }
      }
    }
  }
}
```

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

### GET /customer/offerings

Source: https://www.revenuecat.com/docs/api-v1/offerings.md

Gets offerings for the authenticated customer. This operation is part of the Offerings API.

```APIDOC
## GET /customer/offerings

### Description
Gets offerings for the authenticated customer.

### Method
GET

### Endpoint
/customer/offerings

```

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

### Create a Purchase Request Body JSON

Source: https://www.revenuecat.com/docs/api-v1/transactions.md

Example JSON payload for the POST /receipts endpoint, including required fields like app_user_id and fetch_token, as well as optional attributes.

```json
{
  "app_user_id": "string",
  "fetch_token": "string",
  "product_id": "com.my.product.iap",
  "price": 1.99,
  "currency": "USD",
  "payment_mode": "string",
  "introductory_price": 0.1,
  "is_restore": false,
  "presented_offering_identifier": "string",
  "attributes": {
    "property1": {
      "value": "string",
      "updated_at_ms": 1709195668093
    },
    "property2": {
      "value": "string",
      "updated_at_ms": 1709195668093
    }
  }
}
```

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

### GET /auth/{project_id}/.well-known/jwks.json

Source: https://www.revenuecat.com/docs/api-v1/customers.md

Gets the public keys that verify the signature of the access tokens of your project, as a JSON Web Key Set. This endpoint is public and needs no credentials. Cache the response.

```APIDOC
## [GET] /auth/{project_id}/.well-known/jwks.json

### Description
Gets the public keys that verify the signature of the access tokens of your project, as a JSON Web Key Set. Match the `kid` header of an access token to the `kid` of a key. This endpoint is public and needs no credentials. Cache the response.

### Method
GET

### Endpoint
https://api.revenuecat.com/auth/{project_id}/.well-known/jwks.json

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of your RevenueCat project, from **Project Settings → General** in the dashboard.

### Response
#### Success Response (200)
The public keys of the project. The list is empty when the project has no signing keys or doesn't exist.

#### Response Example
```json
{
  "keys": [
    {
      "kty": "RSA",
      "alg": "RS256",
      "use": "sig",
      "kid": "string",
      "n": "string",
      "e": "AQAB"
    }
  ]
}
```
```

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

### GET /subscribers/{app_user_id}

Source: https://www.revenuecat.com/docs/api-v1/customers.md

Gets the latest Customer Info for the customer with the given App User ID, or creates a new customer if it doesn't exist. Requires Bearer authentication.

```APIDOC
## GET /subscribers/{app_user_id}

### Description
Gets the latest Customer Info for the customer with the given App User ID, or creates a new customer if it doesn't exist.

### Method
GET

### Endpoint
https://api.revenuecat.com/v1/subscribers/{app_user_id}

### Parameters
#### Path Parameters
- **app_user_id** (string) - Required - The App User ID used with the mobile SDK.

#### Header Parameters
- **X-Platform** (string) - Optional - Optionally set to update the Customer's last_seen field. Set to either ios, android, amazon, macos, uikitformac. Don't set this if you are calling the getter for informational purposes or using a secret API key to fetch the customer's attributes.

### Authorizations
- BearerAuth

### Responses
#### 200 - Success (customer found)
Returns the Customer Info for the Customer.

#### 201 - Success (customer created)
Returns the Customer Info for the Customer.

#### 400 - Bad Request

#### 401 - Unauthorized

### Response Example
```json
{
  "request_date": "2019-07-26T17:40:10Z",
  "request_date_ms": 1564162810884,
  "subscriber": {
    "entitlements": {
      "pro_cat": {
        "expires_date": null,
        "grace_period_expires_date": null,
        "product_identifier": "onetime",
        "purchase_date": "2019-04-05T21:52:45Z"
      }
    },
    "first_seen": "2019-02-21T00:08:41Z",
    "management_url": "https://apps.apple.com/account/subscriptions",
    "non_subscriptions": {
      "onetime": [
        {
          "id": "cadba0c81b",
          "is_sandbox": true,
          "purchase_date": "2019-04-05T21:52:45Z",
          "store": "app_store"
        }
      ]
    },
    "original_app_user_id": "XXX-XXXXX-XXXXX-XX",
    "original_application_version": "1.0",
    "original_purchase_date": "2019-01-30T23:54:10Z",
    "other_purchases": {},
    "subscriptions": {
      "annual": {
        "auto_resume_date": null,
        "billing_issues_detected_at": null,
        "expires_date": "2019-08-14T21:07:40Z",
        "grace_period_expires_date": null,
        "is_sandbox": true,
        "original_purchase_date": "2019-02-21T00:42:05Z",
        "ownership_type": "PURCHASED",
        "period_type": "normal",
        "purchase_date": "2019-07-14T20:07:40Z",
        "refunded_at": null,
        "store": "play_store",
        "store_transaction_id": "GPA.6801-7988-0152-76034..5",
        "unsubscribe_detected_at": "2019-07-17T22:48:38Z"
      },
      "onemonth": {
        "auto_resume_date": null,
        "billing_issues_detected_at": null,
        "expires_date": "2019-06-17T22:47:55Z",
        "grace_period_expires_date": null,
        "is_sandbox": true,
        "original_purchase_date": "2019-02-21T00:42:05Z",
        "ownership_type": "PURCHASED",
        "period_type": "normal",
        "purchase_date": "2019-06-17T22:42:55Z",
        "refunded_at": null,
        "store": "app_store",
        "store_transaction_id": 1000000652379790,
        "unsubscribe_detected_at": "2019-06-17T22:48:38Z"
      },
      "rc_promo_pro_cat_monthly": {
        "auto_resume_date": null,
        "billing_issues_detected_at": null,
        "expires_date": "2019-08-26T01:02:16Z",
        "grace_period_expires_date": null,
        "is_sandbox": false,
        "original_purchase_date": "2019-07-26T01:02:16Z",
        "ownership_type": "FAMILY_SHARED",
        "period_type": "normal",
        "purchase_date": "2019-07-26T01:02:16Z",
        "refunded_at": null,
        "store": "promotional",
        "store_transaction_id": "a42db3af39530cb82b17eaf9c6576393",
        "unsubscribe_detected_at": null
      }
    }
  }
}
```
```

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

### Spend Authenticated Customer Virtual Currencies Request

Source: https://www.revenuecat.com/docs/api-v1/customers.md

Example JSON request body for spending virtual currency, including currency adjustments and an optional reference ID.

```json
{
  "adjustments": {
    "GLD": 20,
    "SLV": 10
  },
  "reference": "my_custom_transaction_id"
}
```

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

### Offerings Response Schema

Source: https://www.revenuecat.com/docs/api-v1/offerings.md

Response schema for endpoints that return offerings information, including get offerings operations. Contains current_offering_id and a list of offerings with packages.

```APIDOC
## Offerings Response Schema

### Description
Response schema for endpoints that return offerings information, including get offerings operations.

### Used By
- GET /subscribers/{app_user_id}/offerings (200) — Get Offerings
- GET /customer/offerings (200) — Get Authenticated Customer Offerings

### Fields
- current_offering_id (string) — The identifier of the current Offering for this Customer. Targeting, Offering overrides, and Experiments affect this identifier depending on the App User ID.
- offerings (array of object) — A list of available Offerings.
  - description (string) — The Offering's description.
  - identifier (string) — The Offering's identifier.
  - packages (array of object) — The Packages of this Offering.
    - identifier (string) — The package's identifier. If you used one of RevenueCat's default identifiers, it will be prefixed by $rc_.
    - platform_product_identifier (string) — The identifier of the product in the store. This should be used to fetch the product from Apple, Google, Amazon, or Stripe depending on the platform. This field will be populated only for the current app based on the API key used and the X-Platform header.
```

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

### GET /customer

Source: https://www.revenuecat.com/docs/api-v1/customers.md

Retrieves the authenticated customer's subscription and entitlement information. Returns an AuthenticatedSubscriber object containing subscriber details and user identity information.

```APIDOC
## GET /customer

### Description
Retrieves the authenticated customer's subscription and entitlement information.

### Method
GET

### Endpoint
/customer

### Response
#### Success Response (200)
- **request_date** (string) - Date of the request in ISO 8601 format.
- **request_date_ms** (integer, int64) - Date of the request in milliseconds since Epoch.
- **subscriber** (object) - Information about the Customer.
  - **entitlements** (object) - Dictionary of the entitlements of this Customer (including any expired entitlements).
  - **first_seen** (string) - The ISO 8601 datetime string corresponding to when the Customer was first seen by RevenueCat.
  - **last_seen** (string) - The ISO 8601 datetime string corresponding to when the Customer was last seen by RevenueCat.
  - **management_url** (string) - URL to manage the active subscription of the Customer.
  - **non_subscriptions** (object) - Non-subscription purchases of the Customer, keyed by the product identifier.
  - **original_app_user_id** (string) - The App User ID under which this Customer was first known to RevenueCat.
  - **original_application_version** (string) - Only available on iOS. Will be null until an iOS receipt is sent.
  - **original_purchase_date** (string) - Only available on iOS. The date that the app was first purchased/downloaded by the Customer.
  - **other_purchases** (object)
  - **subscriber_attributes** (object) - A dictionary of any Attributes set on this Customer. Only included in responses to requests made with a secret API key.
  - **subscriptions** (object) - Subscription purchases of the Customer, keyed by the product identifier.
- **user** (object) - The user behind the access token. Present only when the token comes from a sign-in with an identity provider.
  - **id** (string) - The RevenueCat identifier of the user.
  - **identities** (array of object) - The identities attached to the user, oldest first.
    - **method** (string) - The authentication method of the identity.
    - **id** (string) - The identifier of the user at the identity provider.
  - **amr** (array of string) - The authentication methods used to obtain this access token.

#### Response Example
{
  "request_date": "2023-01-01T00:00:00Z",
  "request_date_ms": 1672531200000,
  "subscriber": {
    "entitlements": {},
    "first_seen": "2023-01-01T00:00:00Z",
    "last_seen": "2023-01-01T00:00:00Z",
    "management_url": "https://example.com",
    "non_subscriptions": {},
    "original_app_user_id": "user123",
    "original_application_version": "1.0",
    "original_purchase_date": "2023-01-01T00:00:00Z",
    "other_purchases": {},
    "subscriber_attributes": {},
    "subscriptions": {}
  },
  "user": {
    "id": "user123",
    "identities": [
      {
        "method": "apple",
        "id": "apple-id"
      }
    ],
    "amr": ["apple"]
  }
}
```

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

### GET /customer

Source: https://www.revenuecat.com/docs/api-v1/customers.md

Get authenticated customer. This endpoint retrieves the customer information for the authenticated customer.

```APIDOC
## GET /customer

### Description
Get authenticated customer. This endpoint retrieves the customer information for the authenticated customer.

### Method
GET

### Endpoint
/customer

```

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

### GET /subscribers/{app_user_id}/offerings

Source: https://www.revenuecat.com/docs/api-v1/offerings.md

Gets the offerings for a specific subscriber. This operation is part of the Offerings API.

```APIDOC
## GET /subscribers/{app_user_id}/offerings

### Description
Gets the offerings for a specific subscriber.

### Method
GET

### Endpoint
/subscribers/{app_user_id}/offerings

### Parameters
#### Path Parameters
- **app_user_id** (string) - Required - The app user ID of the customer.

```

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

### GET /customer/virtual_currencies

Source: https://www.revenuecat.com/docs/api-v1/customers.md

Get authenticated customer in-app currency balances. This endpoint retrieves the in-app currency balances for the authenticated customer.

```APIDOC
## GET /customer/virtual_currencies

### Description
Get authenticated customer in-app currency balances. This endpoint retrieves the in-app currency balances for the authenticated customer.

### Method
GET

### Endpoint
/customer/virtual_currencies

```

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

### POST /customer/offerings/{offering_uuid}/override

Source: https://www.revenuecat.com/docs/api-v1/offerings.md

Overrides the current Offering for the Customer identified by the access token. Requires an authentication access token. Returns the updated Customer Info on success.

```APIDOC
## POST /customer/offerings/{offering_uuid}/override

### Description
Overrides the current Offering for the Customer identified by the access token. Works like Override a Customer's Current Offering. Requires an Authentication access token.

### Method
POST

### Endpoint
https://api.revenuecat.com/v1/customer/offerings/{offering_uuid}/override

### Parameters
#### Path Parameters
- **offering_uuid** (string) - Required - The UUID for the offering you want to set as the override for the Customer. The UUID can be found in the URL of the offering.

### Authorizations
_AccessToken_

### Responses

**200** - Offering was successfully overridden. Returns the updated Customer Info for the Customer.

**401** - The access token is missing, invalid, or expired.

**404** - The offering or the Customer was not found.

### Response Example
```json
{
  "value": {
    "request_date": "2019-07-26T17:40:10Z",
    "request_date_ms": 1564162810884,
    "subscriber": {
      "entitlements": {
        "pro_cat": {
          "expires_date": null,
          "grace_period_expires_date": null,
          "product_identifier": "onetime",
          "purchase_date": "2019-04-05T21:52:45Z"
        }
      },
      "first_seen": "2019-02-21T00:08:41Z",
      "management_url": "https://apps.apple.com/account/subscriptions",
      "non_subscriptions": {
        "onetime": [
          {
            "id": "cadba0c81b",
            "is_sandbox": true,
            "purchase_date": "2019-04-05T21:52:45Z",
            "store": "app_store"
          }
        ]
      },
      "original_app_user_id": "XXX-XXXXX-XXXXX-XX",
      "original_application_version": "1.0",
      "original_purchase_date": "2019-01-30T23:54:10Z",
      "other_purchases": {},
      "subscriptions": {
        "annual": {
          "auto_resume_date": null,
          "billing_issues_detected_at": null,
          "expires_date": "2019-08-14T21:07:40Z",
          "grace_period_expires_date": null,
          "is_sandbox": true,
          "original_purchase_date": "2019-02-21T00:42:05Z",
          "ownership_type": "PURCHASED",
          "period_type": "normal",
          "purchase_date": "2019-07-14T20:07:40Z",
          "refunded_at": null,
          "store": "play_store",
          "store_transaction_id": "GPA.6801-7988-0152-76034..5",
          "unsubscribe_detected_at": "2019-07-17T22:48:38Z"
        },
        "onemonth": {
          "auto_resume_date": null,
          "billing_issues_detected_at": null,
          "expires_date": "2019-06-17T22:47:55Z",
          "grace_period_expires_date": null,
          "is_sandbox": true,
          "original_purchase_date": "2019-02-21T00:42:05Z",
          "ownership_type": "PURCHASED",
          "period_type": "normal",
          "purchase_date": "2019-06-17T22:42:55Z",
          "refunded_at": null,
          "store": "app_store",
          "store_transaction_id": 1000000652379790,
          "unsubscribe_detected_at": "2019-06-17T22:48:38Z"
        },
        "rc_promo_pro_cat_monthly": {
          "auto_resume_date": null,
          "billing_issues_detected_at": null,
          "expires_date": "2019-08-26T01:02:16Z",
          "grace_period_expires_date": null,
          "is_sandbox": false,
          "original_purchase_date": "2019-07-26T01:02:16Z",
          "ownership_type": "FAMILY_SHARED",
          "period_type": "normal",
          "purchase_date": "2019-07-26T01:02:16Z",
          "refunded_at": null,
          "store": "promotional",
          "store_transaction_id": "a42db3af39530cb82b17eaf9c6576393",
          "unsubscribe_detected_at": null
        }
      }
    }
  }
}
```
```

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

### GET /{project_id}/.well-known/jwks.json

Source: https://www.revenuecat.com/docs/api-v1/customers.md

Get project public keys (JWKS). This endpoint retrieves the JSON Web Key Set (JWKS) for the given project.

```APIDOC
## GET /{project_id}/.well-known/jwks.json

### Description
Get project public keys (JWKS). This endpoint retrieves the JSON Web Key Set (JWKS) for the given project.

### Method
GET

### Endpoint
/{project_id}/.well-known/jwks.json

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The project ID.

```

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

### POST /subscribers/{app_user_id}/subscriptions/{product_identifier}/defer

Source: https://www.revenuecat.com/docs/api-v1/transactions.md

Defers the purchase of a Google Subscription to a later date. Provide either expiry_time_ms or extend_by_days to set the new expiry. Returns the updated Customer Info.

```APIDOC
## POST /subscribers/{app_user_id}/subscriptions/{product_identifier}/defer

### Description
Defers the purchase of a Google Subscription to a later date.

### Method
POST

### Endpoint
https://api.revenuecat.com/v1/subscribers/{app_user_id}/subscriptions/{product_identifier}/defer

### Parameters
#### Path Parameters
- **app_user_id** (string) - Required - The App User ID of the Customer.
- **product_identifier** (string) - Required - The identifier of the product belonging to the subscription that is being deferred. This can be found in RevenueCat's Product catalog -> {Product} -> Subscription Id.

#### Request Body
- **expiry_time_ms** (integer int64) - Optional - The desired next expiry time to assign to the subscription, in milliseconds since the Epoch. The given time must be later/greater than the current expiry time for the subscription. Either expiry_time_ms or extend_by_days must be provided.
- **extend_by_days** (integer [1..365]) - Optional - The number of days to extend the subscription renewal date. Must be between 1 and 365. Either expiry_time_ms or extend_by_days must be provided.

### Request Example
{
  "expiry_time_ms": 1708417962662,
  "extend_by_days": 30
}

### Response
#### Success Response (200)
Subscription was successfully deferred. Returns the updated Customer Info.

#### Response Example
{
  "value": {
    "request_date": "2019-07-26T17:40:10Z",
    "request_date_ms": 1564162810884,
    "subscriber": {
      "entitlements": {
        "pro_cat": {
          "expires_date": null,
          "grace_period_expires_date": null,
          "product_identifier": "onetime",
          "purchase_date": "2019-04-05T21:52:45Z"
        }
      },
      "first_seen": "2019-02-21T00:08:41Z",
      "management_url": "https://apps.apple.com/account/subscriptions",
      "non_subscriptions": {
        "onetime": [
          {
            "id": "cadba0c81b",
            "is_sandbox": true,
            "purchase_date": "2019-04-05T21:52:45Z",
            "store": "app_store"
          }
        ]
      },
      "original_app_user_id": "XXX-XXXXX-XXXXX-XX",
      "original_application_version": "1.0",
      "original_purchase_date": "2019-01-30T23:54:10Z",
      "other_purchases": {},
      "subscriptions": {
        "annual": {
          "auto_resume_date": null,
          "billing_issues_detected_at": null,
          "expires_date": "2019-08-14T21:07:40Z",
          "grace_period_expires_date": null,
          "is_sandbox": true,
          "original_purchase_date": "2019-02-21T00:42:05Z",
          "ownership_type": "PURCHASED",
          "period_type": "normal",
          "purchase_date": "2019-07-14T20:07:40Z",
          "refunded_at": null,
          "store": "play_store",
          "store_transaction_id": "GPA.6801-7988-0152-76034..5",
          "unsubscribe_detected_at": "2019-07-17T22:48:38Z"
        },
        "onemonth": {
          "auto_resume_date": null,
          "billing_issues_detected_at": null,
          "expires_date": "2019-06-17T22:47:55Z",
          "grace_period_expires_date": null,
          "is_sandbox": true,
          "original_purchase_date": "2019-02-21T00:42:05Z",
          "ownership_type": "PURCHASED",
          "period_type": "normal",
          "purchase_date": "2019-06-17T22:42:55Z",
          "refunded_at": null,
          "store": "app_store",
          "store_transaction_id": 1000000652379790,
          "unsubscribe_detected_at": "2019-06-17T22:48:38Z"
        },
        "rc_promo_pro_cat_monthly": {
          "auto_resume_date": null,
          "billing_issues_detected_at": null,
          "expires_date": "2019-08-26T01:02:16Z",
          "grace_period_expires_date": null,
          "is_sandbox": false,
          "original_purchase_date": "2019-07-26T01:02:16Z",
          "ownership_type": "FAMILY_SHARED",
          "period_type": "normal",
          "purchase_date": "2019-07-26T01:02:16Z",
          "refunded_at": null,
          "store": "promotional",
          "store_transaction_id": "a42db3af39530cb82b17eaf9c6576393",
          "unsubscribe_detected_at": null
        }
      }
    }
  }
}
```

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

### POST /receipts

Source: https://www.revenuecat.com/docs/api-v1/transactions.md

Records a purchase for a Customer from iOS, Android, Stripe, Roku, and Paddle. Will create a Customer if they don't already exist.

```APIDOC
## POST /receipts

### Description
Records a purchase for a Customer from iOS, Android, Stripe, Roku, and Paddle. Will create a Customer if they don't already exist.

### Method
POST

### Endpoint
https://api.revenuecat.com/v1/receipts

### Authorizations
BearerAuth

### Parameters
#### Header Parameters
- **X-Platform** (string) - Required - The platform this purchase is for. Either `ios`, `android`, `amazon`, `macos`, `uikitformac`, `stripe`, `roku`, or `paddle`.

#### Request Body
- **app_user_id** (string) - Required - App User ID of the Customer the receipt is associated with.
- **fetch_token** (string) - Required - For iOS, the base64 encoded receipt file (or JWSTransaction for StoreKit2), for Android the receipt token, for Amazon the receipt, for Stripe the subscription ID or the Stripe Checkout Session ID, for Roku the transaction ID, and for Paddle the subscription ID or transaction ID.
- **product_id** (string) - Optional - The Apple, Google, Amazon, Roku, or Paddle product identifier or SKU. Required for Google.
- **price** (number float) - Optional - The price of the product. Required if you provide a currency.
- **currency** (string) - Optional - Default: "USD" - The currency of the product. The currency must be in ISO 4217 format. Required if you provide a price.
- **payment_mode** (string) - Optional - Optionally used by the iOS SDK to communicate intro pricing periods. Either `pay_as_you_go = 0`, `pay_up_front = 1`, or `free_trial = 2`. Defaults to `2` (free trial) if an introductory period is detected in the receipt but this value is not provided.
- **introductory_price** (number float) - Optional - Introductory price paid.
- **is_restore** (boolean) - Optional - Deprecated - Default: false - If true, the fetch token will trigger your configured restore behavior for any other users sharing the same fetch token.
- **presented_offering_identifier** (string) - Optional - The offering that was presented to the Customer at the time of purchase. This will be attached to any new transactions in this fetch token and will be available in ETL exports and webhooks.
- **attributes** (object) - Optional - Any Attributes to set on the Customer as a dictionary keyed by the Attribute name.
  - **value** (string) - Required - The value of the attribute. If the value is `null` or an empty string, the attribute will be deleted.
  - **updated_at_ms** (integer int64) - Optional - UNIX epoch in milliseconds of when the attribute was updated. This value is used to resolve conflicts, an attribute will only be updated if the new `updated_at_ms` value is newer than the value for the stored attribute.

### Request Example
```json
{
  "app_user_id": "string",
  "fetch_token": "string",
  "product_id": "com.my.product.iap",
  "price": 1.99,
  "currency": "USD",
  "payment_mode": "string",
  "introductory_price": 0.1,
  "is_restore": false,
  "presented_offering_identifier": "string",
  "attributes": {
    "property1": {
      "value": "string",
      "updated_at_ms": 1709195668093
    },
    "property2": {
      "value": "string",
      "updated_at_ms": 1709195668093
    }
  }
}
```

### Response
#### Success Response (200)
Purchase was successfully posted. Returns the updated Customer Info for the Customer for which the purchase was posted.

```

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

### GET /v1/customer/virtual_currencies

Source: https://www.revenuecat.com/docs/api-v1/customers.md

Gets the in-app currency balances of the Customer identified by the access token, including currencies with a zero balance. Requires an Authentication access token.

```APIDOC
## GET /v1/customer/virtual_currencies

### Description
Gets the in-app currency balances of the Customer identified by the access token, including currencies with a zero balance.

### Method
GET

### Endpoint
https://api.revenuecat.com/v1/customer/virtual_currencies

### Authorizations
- AccessToken

### Response
#### Success Response (200)
Returns the balances of the Customer.

#### Success Response (201)
The Customer was created by this request. Returns the balances of the Customer.

#### Error Response (401)
The access token is missing, invalid, or expired.

#### Response Example
```json
{
  "virtual_currencies": {
    "property1": {
      "balance": 100,
      "name": "Gold",
      "code": "GLD",
      "description": "Premium currency"
    },
    "property2": {
      "balance": 100,
      "name": "Gold",
      "code": "GLD",
      "description": "Premium currency"
    }
  }
}
```
```

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

### GET /v1/subscribers/{app_user_id}/offerings

Source: https://www.revenuecat.com/docs/api-v1/offerings.md

Gets the offerings for your app for a specific App User ID. Requires Bearer authentication and supports platform-specific packages via the X-Platform header.

```APIDOC
## GET /v1/subscribers/{app_user_id}/offerings

### Description
Gets the offerings for your app for a specific App User ID.

### Method
GET

### Endpoint
https://api.revenuecat.com/v1/subscribers/{app_user_id}/offerings

### Parameters
#### Path Parameters
- **app_user_id** (string) - Required - The App User ID used with the mobile SDK. The App User ID doesn't have to exist for the endpoint to work but it can affect the current offering depending on whether you have any Experiments running or have overridden the current offering for this specific App User ID.

#### Header Parameters
- **X-Platform** (string) - Optional - Set the X-Platform header to fetch that platform's packages. Can be `ios`, `android`, `amazon`, `stripe`, `roku`, or `paddle`. This header is required if you use a legacy public API key to determine which store the products should be returned for. It is not required if you use a new, app-specific API key, in which case the products for the app associated with the API key will be returned.

### Authorizations
BearerAuth

### Responses
#### Success Response (200)
Offerings for the Customer.

#### Response Example
{
  "value": {
    "current_offering_id": "default",
    "offerings": [
      {
        "description": "The default offering",
        "identifier": "default",
        "packages": [
          {
            "identifier": "$rc_monthly",
            "platform_product_identifier": "monthly_free_trial"
          },
          {
            "identifier": "consumable",
            "platform_product_identifier": "consumable1"
          },
          {
            "identifier": "$rc_annual",
            "platform_product_identifier": "yearly_free_trial"
          }
        ]
      },
      {
        "description": "The sale offeringg",
        "identifier": "sale_offering",
        "packages": [
          {
            "identifier": "$rc_monthly",
            "platform_product_identifier": "monthly_free_trial_sale"
          },
          {
            "identifier": "consumable",
            "platform_product_identifier": "consumable1_sale"
          },
          {
            "identifier": "$rc_annual",
            "platform_product_identifier": "yearly_free_trial_sale"
          }
        ]
      }
    ]
  }
}

#### Error Responses
- **400** - 400
- **403** - 403
```
Tokens:
Raw