Offerings | REST API v1 Reference (1.0)

Download OpenAPI specification:Download

RevenueCat API v1 endpoint reference for Offerings.

Offerings

Part of the REST API v1 Reference.

Operations about offerings.

Endpoints

Override a Customer's Current Offering — POST /subscribers/{app_user_id}/offerings/{offering_uuid}/override
Remove a Customer's Current Offering Override — DELETE /subscribers/{app_user_id}/offerings/override
Get Offerings — GET /subscribers/{app_user_id}/offerings

Override a Customer's Current Offering

Overrides the current Offering for a specific Customer

Authorizations:

BearerAuth

path Parameters

app_user_id required	string The App User ID of the Customer.
offering_uuid required	string 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. For example, the offering UUID in https://app.revenuecat.com/apps/abcd1234/offerings/ofrng1234567abc is `ofrng1234567abc`.

Responses

Response samples

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

Remove a Customer's Current Offering Override

Reset the offering overrides back to the current offering for a specific Customer

Authorizations:

BearerAuth

path Parameters

app_user_id

required

string

The App User ID of the Customer.

Responses

Response samples

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

Get Offerings

Gets the offerings for your app.

Authorizations:

BearerAuth

path Parameters

app_user_id

required

string

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

Example: ios

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.

Responses

Response samples

Content type

application/json

{"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"
}
]
}
]
}
}

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