Download OpenAPI specification:Download
Part of the REST API v2 Reference. More Customer endpoints: Customer.
Operations about customers.
GET /projects/{project_id}/customers/{customer_id}/customer_centerGET /projects/{project_id}/customers/{customer_id}/subscriptionsGET /projects/{project_id}/customers/{customer_id}/purchasesGET /projects/{project_id}/customers/{customer_id}/active_entitlementsGET /projects/{project_id}/customers/{customer_id}/eventsGET /projects/{project_id}/customers/{customer_id}/virtual_currenciesPOST /projects/{project_id}/customers/{customer_id}/virtual_currencies/transactionsPOST /projects/{project_id}/customers/{customer_id}/virtual_currencies/update_balanceThis endpoint requires the following permission(s): customer_information:customers:read. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.
| project_id required | string <= 255 characters Example: proj1ab2c3d4 ID of the project |
| customer_id required | string [ 1 .. 1500 ] characters Example: 19b8de26-77c1-49f1-aa18-019a391603e2 ID of the customer |
| platform | string Enum: "app_store" "play_store" "mac_app_store" "stripe" "amazon" Example: platform=app_store The platform to process the Customer Center configuration for. When provided, returns the locale-selected, platform-filtered configuration the customer would see. When omitted, returns the full unprocessed configuration for all platforms. Must match a store configured on this project. |
| locale | string Example: locale=en_US BCP 47 locale string (e.g. en_US) used to select the appropriate localization when platform is provided. When omitted, the configuration's default locale is used. Has no effect if platform is not provided. |
{- "object": "customer_center_config",
- "customer_center": { }
}This endpoint requires the following permission(s): customer_information:subscriptions:read. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.
| project_id required | string <= 255 characters Example: proj1ab2c3d4 ID of the project |
| customer_id required | string [ 1 .. 1500 ] characters Example: 19b8de26-77c1-49f1-aa18-019a391603e2 ID of the customer |
| environment | string Enum: "sandbox" "production" Example: environment=production Filter by environment, omit to include both. |
| starting_after | string Example: starting_after=ent12354 Pagination cursor. Pass the id of the last item from the previous page to fetch the next page; omit for the first page. |
| limit | integer Default: 20 Example: limit=10 Maximum number of items to return per page. Values below 1 or above 100 are clamped to that range rather than rejected. |
| expand | Array of strings[ items [ 1 .. 5000 ] characters ] Items Value: "items.redemption" Example: expand=items.redemption Specifies which fields in the response should be expanded.
Accepted values are: |
{- "object": "list",
- "items": [
- {
- "object": "subscription",
- "id": "sub1ab2c3d4e5",
- "customer_id": "19b8de26-77c1-49f1-aa18-019a391603e2",
- "original_customer_id": "19b8de26-77c1-49f1-aa18-019a391603e2",
- "product_id": "prod1a2b3c4d5e",
- "starts_at": 1658399423658,
- "current_period_starts_at": 1658399423658,
- "current_period_ends_at": 1658399423658,
- "ends_at": 1658399423658,
- "gives_access": true,
- "pending_payment": true,
- "auto_renewal_status": "will_renew",
- "status": "trialing",
- "total_revenue_in_usd": {
- "currency": "USD",
- "gross": 9.99,
- "commission": 2.99,
- "tax": 0.75,
- "proceeds": 6.25
}, - "presented_offering_id": "ofrnge1a2b3c4d5",
- "entitlements": {
- "object": "list",
- "items": [
- {
- "state": "active",
- "object": "entitlement",
- "project_id": "proj1ab2c3d4",
- "id": "entla1b2c3d4e5",
- "lookup_key": "premium",
- "display_name": "Premium",
- "created_at": 1658399423658,
- "products": {
- "object": "list",
- "items": [
- {
- "state": "active",
- "object": "product",
- "id": "prod1a2b3c4d5e",
- "store_identifier": "rc_1w_199",
- "type": "subscription",
- "subscription": {
- "duration": null,
- "grace_period_duration": null,
- "trial_duration": null
}, - "one_time": {
- "is_consumable": null
}, - "created_at": 1658399423658,
- "app_id": "app1a2b3c4",
- "app": {
- "object": null,
- "id": null,
- "name": null,
- "created_at": null,
- "type": null,
- "project_id": null,
- "custom_url_scheme": null,
- "amazon": { }
}, - "indicative_price": {
- "object": null,
- "currency": null,
- "country": null,
- "amount_micros": null
}, - "display_name": "Premium Monthly 2023"
}
], - "next_page": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products?starting_after=prodeab21dac",
- "url": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products"
}
}
], - "next_page": "/v2/projects/proj1ab2c3d4/subscriptions/sub1a2b3c4d5e/entitlements?status=active&starting_after=entlab21dac",
- "url": "/v2/projects/proj1ab2c3d4/subscriptions/sub1a2b3c4d5e/entitlements"
}, - "environment": "production",
- "store": "amazon",
- "store_subscription_identifier": 12345678,
- "ownership": "purchased",
- "pending_changes": {
- "product": {
- "state": "active",
- "object": "product",
- "id": "prod1a2b3c4d5e",
- "store_identifier": "rc_1w_199",
- "type": "subscription",
- "subscription": {
- "duration": "P1M",
- "grace_period_duration": "P3D",
- "trial_duration": "P1W"
}, - "one_time": {
- "is_consumable": true
}, - "created_at": 1658399423658,
- "app_id": "app1a2b3c4",
- "app": {
- "object": "app",
- "id": "app1a2b3c4",
- "name": "string",
- "created_at": 1658399423658,
- "type": "amazon",
- "project_id": "proj1a2b3c4",
- "custom_url_scheme": "rc-1a2b3c4",
- "amazon": {
- "package_name": "string"
}
}, - "indicative_price": {
- "object": "indicative_price",
- "currency": "USD",
- "country": "US",
- "amount_micros": "For 99.99, the value should be 99990000"
}, - "display_name": "Premium Monthly 2023"
}, - "current_period_starts_at": 1658399423658,
- "current_period_ends_at": 1660991423658,
- "store_subscription_identifier": 12345679,
- "auto_renewal_status": "will_renew",
- "status": "active",
- "pending_payment": false,
- "gives_access": true
}, - "country": "US",
- "redemption": {
- "object": "redemption",
- "redeemed_at": 1658399423658
}, - "product_change": {
- "status": "pending",
- "product_id": "prod1a2b3c4d5e"
}
}
], - "next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/subscriptions?starting_after=sub1a2b3c4d",
- "url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/subscriptions"
}This endpoint requires the following permission(s): customer_information:purchases:read. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.
| project_id required | string <= 255 characters Example: proj1ab2c3d4 ID of the project |
| customer_id required | string [ 1 .. 1500 ] characters Example: 19b8de26-77c1-49f1-aa18-019a391603e2 ID of the customer |
| environment | string Enum: "sandbox" "production" Example: environment=production Filter by environment, omit to include both. |
| starting_after | string Example: starting_after=ent12354 Pagination cursor. Pass the id of the last item from the previous page to fetch the next page; omit for the first page. |
| limit | integer Default: 20 Example: limit=10 Maximum number of items to return per page. Values below 1 or above 100 are clamped to that range rather than rejected. |
| expand | Array of strings[ items [ 1 .. 5000 ] characters ] Items Value: "items.redemption" Example: expand=items.redemption Specifies which fields in the response should be expanded.
Accepted values are: |
{- "object": "list",
- "items": [
- {
- "object": "purchase",
- "id": "purch1a2b3c4d5e",
- "customer_id": "19b8de26-77c1-49f1-aa18-019a391603e2",
- "original_customer_id": "19b8de26-77c1-49f1-aa18-019a391603e2",
- "product_id": "prod1a2b3c4d5e",
- "purchased_at": 1658399423658,
- "revenue_in_usd": {
- "currency": "USD",
- "gross": 9.99,
- "commission": 2.99,
- "tax": 0.75,
- "proceeds": 6.25
}, - "quantity": 1,
- "status": "owned",
- "presented_offering_id": "ofrnge1a2b3c4d5",
- "entitlements": {
- "object": "list",
- "items": [
- {
- "state": "active",
- "object": "entitlement",
- "project_id": "proj1ab2c3d4",
- "id": "entla1b2c3d4e5",
- "lookup_key": "premium",
- "display_name": "Premium",
- "created_at": 1658399423658,
- "products": {
- "object": "list",
- "items": [
- {
- "state": "active",
- "object": "product",
- "id": "prod1a2b3c4d5e",
- "store_identifier": "rc_1w_199",
- "type": "subscription",
- "subscription": {
- "duration": null,
- "grace_period_duration": null,
- "trial_duration": null
}, - "one_time": {
- "is_consumable": null
}, - "created_at": 1658399423658,
- "app_id": "app1a2b3c4",
- "app": {
- "object": null,
- "id": null,
- "name": null,
- "created_at": null,
- "type": null,
- "project_id": null,
- "custom_url_scheme": null,
- "amazon": { }
}, - "indicative_price": {
- "object": null,
- "currency": null,
- "country": null,
- "amount_micros": null
}, - "display_name": "Premium Monthly 2023"
}
], - "next_page": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products?starting_after=prodeab21dac",
- "url": "/v2/projects/proj1ab2c3d4/entitlements/entle1a2b3c4d5/products"
}
}
], - "next_page": "/v2/projects/proj1ab2c3d4/purchases/sub1a2b3c4d5e/entitlements?status=active&starting_after=entlab21dac",
- "url": "/v2/projects/proj1ab2c3d4/purchases/sub1a2b3c4d5e/entitlements"
}, - "environment": "production",
- "store": "amazon",
- "store_purchase_identifier": 12345678,
- "ownership": "purchased",
- "country": "US",
- "redemption": {
- "object": "redemption",
- "redeemed_at": 1658399423658
}
}
], - "next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/purchases?starting_after=purc1a2b3c4d5e",
- "url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/purchases"
}This endpoint requires the following permission(s): customer_information:customers:read. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.
| project_id required | string <= 255 characters Example: proj1ab2c3d4 ID of the project |
| customer_id required | string [ 1 .. 1500 ] characters Example: 19b8de26-77c1-49f1-aa18-019a391603e2 ID of the customer |
| starting_after | string Example: starting_after=ent12354 Pagination cursor. Pass the id of the last item from the previous page to fetch the next page; omit for the first page. |
| limit | integer Default: 20 Example: limit=10 Maximum number of items to return per page. Values below 1 or above 100 are clamped to that range rather than rejected. |
{- "object": "list",
- "items": [
- {
- "object": "customer.active_entitlement",
- "entitlement_id": "entla1b2c3d4e5",
- "expires_at": 1658399423658
}
], - "next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements?starting_after=entlab21dac",
- "url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/active_entitlements"
}This endpoint requires the following permission(s): customer_information:customers:read. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.
| project_id required | string <= 255 characters Example: proj1ab2c3d4 ID of the project |
| customer_id required | string [ 1 .. 1500 ] characters Example: 19b8de26-77c1-49f1-aa18-019a391603e2 ID of the customer |
| environment | string Enum: "sandbox" "production" Example: environment=production Filter by environment, omit to include both. |
| starting_after | string Example: starting_after=ent12354 Pagination cursor. Pass the id of the last item from the previous page to fetch the next page; omit for the first page. |
| limit | integer Default: 20 Example: limit=10 Maximum number of items to return per page. Values below 1 or above 100 are clamped to that range rather than rejected. |
{- "object": "list",
- "items": [
- {
- "object": "customer.event",
- "id": "2e4ff4cd-27e5-4632-a236-5963c22f36b9",
- "app_id": "app1a2b3c4",
- "type": "PURCHASES_INITIAL_PURCHASE",
- "body": {
- "app_user_id": "customer_123",
- "environment": "PRODUCTION",
- "event_timestamp_ms": 1658399423658,
- "product_id": "premium_monthly",
- "store": "APP_STORE"
}, - "created_at": 1658399423658,
- "occurred_at": 1658399423658
}
], - "next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/events?starting_after=2e4ff4cd-27e5-4632-a236-5963c22f36b9&limit=20",
- "url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/events"
}This endpoint requires the following permission(s): customer_information:purchases:read. This endpoint belongs to the In-App Currencies (Virtual Currencies) domain, which has a default rate limit of 480 requests per minute.
| project_id required | string <= 255 characters Example: proj1ab2c3d4 ID of the project |
| customer_id required | string [ 1 .. 1500 ] characters Example: 19b8de26-77c1-49f1-aa18-019a391603e2 ID of the customer |
| include_empty_balances | boolean Example: include_empty_balances=true Whether to include in-app currencies (virtual currencies) with a zero balance (default false). |
| starting_after | string Example: starting_after=ent12354 Pagination cursor. Pass the id of the last item from the previous page to fetch the next page; omit for the first page. |
| limit | integer Default: 20 Example: limit=10 Maximum number of items to return per page. Values below 1 or above 100 are clamped to that range rather than rejected. |
{- "object": "list",
- "items": [
- {
- "object": "virtual_currency_balance",
- "currency_code": "string",
- "balance": 0,
- "description": "string",
- "name": "string"
}
], - "next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies?starting_after=9fjeja8fjed",
- "url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies"
}This endpoint requires the following permission(s): customer_information:purchases:read_write. This endpoint belongs to the In-App Currencies (Virtual Currencies) domain, which has a default rate limit of 480 requests per minute.
| project_id required | string <= 255 characters Example: proj1ab2c3d4 ID of the project |
| customer_id required | string [ 1 .. 1500 ] characters Example: 19b8de26-77c1-49f1-aa18-019a391603e2 ID of the customer |
| include_empty_balances | boolean Example: include_empty_balances=true Whether to include in-app currencies (virtual currencies) with a zero balance (default false). |
| Idempotency-Key | string <= 255 characters Example: 1234-5678-9101-1121 This is an optional idempotency key to ensure exactly once execution of the request. Maximum length is 255 characters. |
required | object The adjustments to the in-app currencies (virtual currencies) | ||
| |||
| reference | string or null The reference of the transaction | ||
{- "adjustments": {
- "property1": 0,
- "property2": 0
}, - "reference": "string"
}{- "object": "list",
- "items": [
- {
- "object": "virtual_currency_balance",
- "currency_code": "string",
- "balance": 0,
- "description": "string",
- "name": "string"
}
], - "next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies?starting_after=9fjeja8fjed",
- "url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies"
}This endpoint requires the following permission(s): customer_information:purchases:read_write. This endpoint belongs to the In-App Currencies (Virtual Currencies) domain, which has a default rate limit of 480 requests per minute.
| project_id required | string <= 255 characters Example: proj1ab2c3d4 ID of the project |
| customer_id required | string [ 1 .. 1500 ] characters Example: 19b8de26-77c1-49f1-aa18-019a391603e2 ID of the customer |
| include_empty_balances | boolean Example: include_empty_balances=true Whether to include in-app currencies (virtual currencies) with a zero balance (default false). |
| Idempotency-Key | string <= 255 characters Example: 1234-5678-9101-1121 This is an optional idempotency key to ensure exactly once execution of the request. Maximum length is 255 characters. |
required | object The adjustments to the in-app currencies (virtual currencies) | ||
| |||
| reference | string or null The reference of the transaction | ||
{- "adjustments": {
- "property1": 0,
- "property2": 0
}, - "reference": "string"
}{- "object": "list",
- "items": [
- {
- "object": "virtual_currency_balance",
- "currency_code": "string",
- "balance": 0,
- "description": "string",
- "name": "string"
}
], - "next_page": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies?starting_after=9fjeja8fjed",
- "url": "/v2/projects/proj1ab2c3d4/customers/19b8de26-77c1-49f1-aa18-019a391603e2/virtual_currencies"
}All API v2 resources, one page each. General concepts (authentication, pagination, rate limits, error handling) live on the API v2 overview.