Schemas

Partner api_key identifier (e.g., 'dunder_mifflin'). Partner will be created automatically if it doesn't exist.

The URL where you want to receive webhook notifications. This should be a publicly accessible HTTPS endpoint that can accept POST requests.

The type of subscription event you want to receive. Choose one event type per registration. To receive multiple event types, register your URL separately for each event type.

A unique identifier for your registered webhook endpoint. Save this ID if you need to update or manage this endpoint later.

Your partner identifier (same as the one you provided in the request)

The event type this endpoint is registered to receive

The webhook URL where you'll receive notifications

Indicates whether this is a new endpoint registration (true) or an update to an existing endpoint (false)

Bundled user identifier

Bundled username identifier

User's first name

User's last name

User's email address

Temporary password for the account

Subscription plan type (e.g., 'ad-free')

Subscription plan code (e.g., 'PREMIUM_MONTHLY')

Unique subscription token

ISO 8601 timestamp when the subscription was created

User's date of birth (YYYY-MM-DD)

User's country code (e.g., 'US')

User's language code (e.g., 'en')

Unique subscription token

Bundled username identifier

Updated subscription plan type

Updated subscription plan code

ISO 8601 timestamp when the subscription was updated

Unique subscription token

Bundled username identifier

ISO 8601 timestamp when the subscription was cancelled

Reason for cancellation (optional)

Unique subscription token

Bundled username identifier

ISO 8601 timestamp when the subscription was renewed

ISO 8601 timestamp of the new subscription end date