Create Subscription Record

post https://api.triplewhale.com/api/v2/data-in/subscriptions

Ingest subscription data into Triple Whale. This endpoint allows users to upload detailed subscription information, including customer details, items, status, and metadata.

Body Params

shop

string

required

The domain of the shop for which the subscription is being recorded.

subscription_id

string

required

A unique identifier for the subscription.

platform

string

Defaults to custom_subscription_platform

The platform where the subscription was processed.

platform_account_id

string

Defaults to custom_platform_account

The account ID associated with the platform. Can be used to segment parts of the data coming from different platform accounts, e.g. facebook_account_a vs. facebook_account_b.

created_at

date-time

required

The date and time the subscription was created.

canceled_at

date-time

The date and time the subscription was canceled, if applicable.

ended_at

date-time

The date and time the subscription ended, if applicable.

cancelation_reason

string

The reason for the subscription's cancellation.

cancelation_comments

string

Additional comments regarding the cancellation.

currency

string

required

The currency of the subscription (e.g., 'USD').

customer

object

required

Details of the customer associated with the subscription.

subscription_items

array of objects

required

length ≥ 1

Details of the items included in the subscription. At least one is required.

subscription_items*

subscription_item_id

string

required

The unique identifier for the subscription item.

created_at

date-time

required

The date and time the subscription item was created.

canceled_at

date-time

The date and time the subscription item was canceled, if applicable.

ended_at

date-time

The date and time the subscription item ended, if applicable.

status

string

required

The current status of the subscription item.

interval

string

required

The billing interval for the subscription item.

interval_count

integer

required

The number of intervals for each billing cycle.

product_id

string

The unique identifier for the product associated with this item.

price

float

required

The price of the subscription item.

quantity

integer

required

The quantity of the subscription item.

variant_id

string

The unique identifier for the product variant, if applicable.

discount

object

Discounts applied to the subscription item.

status

string

required

The status of the subscription (e.g., active, canceled).

metadata

string

Additional metadata or notes related to the subscription.

updated_at

date-time

The date and time the subscription record was last updated. Defaults to the current timestamp in ISO format.

xxxxxxxxxx
curl --request POST \
     --url https://api.triplewhale.com/api/v2/data-in/subscriptions \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "subscription_items": [
    {
      "status": "active",
      "interval": "day"
    }
  ]
}
'

200Subscription record successfully received.

400Bad Request

429Too Many Requests

500Internal Server Error