Customers | REST API v1 Reference (1.0)

Download OpenAPI specification:Download

RevenueCat API v1 endpoint reference for Customers.

Customers

Operations about customers.

Endpoints

Get or Create Customer — GET /subscribers/{app_user_id}
Delete Customer — DELETE /subscribers/{app_user_id}
Add Customer Attribution Data — POST /subscribers/{app_user_id}/attribution
Update Customer Attributes — POST /subscribers/{app_user_id}/attributes

Get or Create Customer

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

Authorizations:

BearerAuth

path Parameters

app_user_id

required

string

The App User ID used with the mobile SDK.

header Parameters

X-Platform

string

Example: ios

Optionally set the X-Platform header 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.

Responses

Response samples

200
201
400
401

Content type

application/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
}
}
}
}

Delete Customer

Permanently deletes a customer.

Authorizations:

BearerAuth

path Parameters

app_user_id

required

string

The App User ID of the customer to be deleted (might be an aliased App User ID).

Responses

Response samples

200

Content type

application/json

{"app_user_id": "XXX-XXXXX-XXXXX-XX",
"deleted": true
}

Add Customer Attribution Data Deprecated

Attaches attribution data to a subscriber from specific supported networks.

Authorizations:

BearerAuth

path Parameters

app_user_id

required

string

The App User ID of the Customer.

Request Body schema: application/json

required

object

The data returned by the attribution network callbacks.

rc_idfa	string The idfa from AdSupport on iOS. (iOS Only)
rc_gps_adid	string The Google Play Services Advertising identifier. (Android Only)

network

required

string

Enum: "0" "1" "2" "3" "4" "5"

The attribution network the data is coming from:

0: Apple Search AdSupport
1: Adjust
2: AppsFlyer
3: Branch
4: Tenjin
5: Facebook

Responses

Request samples

Payload

Content type

application/json

{"data": {"rc_idfa": "string",
"rc_gps_adid": "string"
},
"network": "0"
}

Response samples

200

Content type

application/json

"{}"

Update Customer Attributes

Updates attributes for a customer.

Authorizations:

BearerAuth

path Parameters

app_user_id

required

string

The App User ID used with the mobile SDK.

Request Body schema: application/json

object

required

object

Mapping of keys to attribute values.

value required	string The value of the attribute. If the value is `null` or an empty string, the attribute will be deleted.
updated_at_ms	integer <int64> 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.

Responses

Request samples

Payload

Content type

application/json

{"attributes": {"key_name": {"value": "string",
"updated_at_ms": 1709195668093
}
}
}

Response samples

200
400

Content type

application/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
}
}
}
}
}

Endpoint Reference

All API v1 resources, one page each. General concepts (authentication, request format, URL parameters) live on the API v1 overview.

Customer Info Model — full schema reference
Customers — 4 endpoints
Entitlements — 2 endpoints
Offerings — 3 endpoints
Offerings Model — full schema reference
Transactions — 6 endpoints