Bundled API

Schemas

WebhookEndpointRegistrationRequest

partner

string · required

Partner slug (e.g., 'northstar_media'). Partner will be created automatically if it doesn't exist.

url

string · uri · required

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

event_type

string · enum · required

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.

Enum values:

subscription.created

subscription.updated

subscription.cancelled

subscription.renewed

object · required

WebhookEndpointRegistrationResponse

endpoint_id

string · required

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

partner

string · required

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

event_type

string · required

The event type this endpoint is registered to receive

url

string · uri · required

The webhook URL where you'll receive notifications

created

boolean · required

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

SubscriptionCreatedPayload

Webhook payload sent to partners when a subscription is created.

event_id

string · required

Unique identifier for this event (e.g. evt_abc123). Stable across delivery retries — use this to deduplicate.

event_timestamp

string · date-time · required

RFC 3339 date-time in UTC when this event was created. Stable across delivery retries.

event_type

string · enum · required

Event type. Always "subscription.created" for this payload.

Enum values:

subscription.created

bundled_user_id

string · required

Bundled user identifier

bundled_username

string · required

Bundled-issued email address

first_name

string · required

User's first name

last_name

string · required

User's last name

email

string · email · required

User's email address

password

string · required

Temporary password for the account

date_of_birth

string · date · required

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

country

string · required

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

language

string · required

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

object · required

Subscription details

SubscriptionUpdatedPayload

Webhook payload sent to partners when a subscription is updated.

event_id

string · required

Unique identifier for this event (e.g. evt_abc123). Stable across delivery retries — use this to deduplicate.

event_timestamp

string · date-time · required

RFC 3339 date-time in UTC when this event was created. Stable across delivery retries.

event_type

string · enum · required

Event type. Always "subscription.updated" for this payload.

Enum values:

subscription.updated

bundled_username

string · required

Bundled-issued email address

object · required

Subscription update details

SubscriptionCancelledPayload

Webhook payload sent to partners when a subscription is cancelled.

event_id

string · required

Unique identifier for this event (e.g. evt_abc123). Stable across delivery retries — use this to deduplicate.

event_timestamp

string · date-time · required

RFC 3339 date-time in UTC when this event was created. Stable across delivery retries.

event_type

string · enum · required

Event type. Always "subscription.cancelled" for this payload.

Enum values:

subscription.cancelled

bundled_username

string · required

Bundled-issued email address

object · required

Subscription cancellation details

SubscriptionRenewedPayload

Webhook payload sent to partners when a subscription is renewed.

event_id

string · required

Unique identifier for this event (e.g. evt_abc123). Stable across delivery retries — use this to deduplicate.

event_timestamp

string · date-time · required

RFC 3339 date-time in UTC when this event was created. Stable across delivery retries.

event_type

string · enum · required

Event type. Always "subscription.renewed" for this payload.

Enum values:

subscription.renewed

bundled_username

string · required

Bundled-issued email address

object · required

Subscription renewal details

WebhookEndpointRegistrationRequest

partner

string · required

Partner slug (e.g., 'northstar_media'). Partner will be created automatically if it doesn't exist.

url

string · uri · required

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

event_type

string · enum · required

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.

Enum values:

subscription.created

subscription.updated

subscription.cancelled

subscription.renewed

object · required

WebhookEndpointRegistrationResponse

endpoint_id

string · required

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

partner

string · required

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

event_type

string · required

The event type this endpoint is registered to receive

url

string · uri · required

The webhook URL where you'll receive notifications

created

boolean · required

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

SubscriptionCreatedPayload

Webhook payload sent to partners when a subscription is created.

event_id

string · required

Unique identifier for this event (e.g. evt_abc123). Stable across delivery retries — use this to deduplicate.

event_timestamp

string · date-time · required

RFC 3339 date-time in UTC when this event was created. Stable across delivery retries.

event_type

string · enum · required

Event type. Always "subscription.created" for this payload.

Enum values:

subscription.created

bundled_user_id

string · required

Bundled user identifier

bundled_username

string · required

Bundled-issued email address

first_name

string · required

User's first name

last_name

string · required

User's last name

email

string · email · required

User's email address

password

string · required

Temporary password for the account

date_of_birth

string · date · required

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

country

string · required

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

language

string · required

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

object · required

Subscription details

SubscriptionUpdatedPayload

Webhook payload sent to partners when a subscription is updated.

event_id

string · required

Unique identifier for this event (e.g. evt_abc123). Stable across delivery retries — use this to deduplicate.

event_timestamp

string · date-time · required

RFC 3339 date-time in UTC when this event was created. Stable across delivery retries.

event_type

string · enum · required

Event type. Always "subscription.updated" for this payload.

Enum values:

subscription.updated

bundled_username

string · required

Bundled-issued email address

object · required

Subscription update details

SubscriptionCancelledPayload

Webhook payload sent to partners when a subscription is cancelled.

event_id

string · required

Unique identifier for this event (e.g. evt_abc123). Stable across delivery retries — use this to deduplicate.

event_timestamp

string · date-time · required

RFC 3339 date-time in UTC when this event was created. Stable across delivery retries.

event_type

string · enum · required

Event type. Always "subscription.cancelled" for this payload.

Enum values:

subscription.cancelled

bundled_username

string · required

Bundled-issued email address

object · required

Subscription cancellation details

SubscriptionRenewedPayload

Webhook payload sent to partners when a subscription is renewed.

event_id

string · required

Unique identifier for this event (e.g. evt_abc123). Stable across delivery retries — use this to deduplicate.

event_timestamp

string · date-time · required

RFC 3339 date-time in UTC when this event was created. Stable across delivery retries.

event_type

string · enum · required

Event type. Always "subscription.renewed" for this payload.

Enum values:

subscription.renewed

bundled_username

string · required

Bundled-issued email address

object · required

Subscription renewal details