Notify Trial Ending

POST

/api/:account_id/subscriptions/:subscription_id/notify-trial-ending

Emit subscription.trial_will_end event. Called by Restate workflow.

This endpoint is called 3 days before a subscription’s trial ends to notify the customer that their trial is ending soon.

Idempotent: If trial_will_end_notified_at is already set, returns “skipped”.

Returns status-based response for workflow orchestration:

status: “notified” or “skipped”
subscription_id: The subscription’s ID
reason: Explanation when status is “skipped”

Emit subscription.trial_will_end event. Called by Restate workflow. This endpoint is called 3 days before a subscription's trial ends to notify the customer that their trial is ending soon. Idempotent: If trial_will_end_notified_at is already set, returns "skipped". Returns status-based response for workflow orchestration: - status: "notified" or "skipped" - subscription_id: The subscription's ID - reason: Explanation when status is "skipped"

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

subscription_idstringRequired

account_idstringRequired

Response

Successful Response

statusstring

subscription_idstring or nullOptional

reasonstring or nullOptional

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/subscriptions/subscription_id/notify-trial-ending \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

Authentication

Path parameters

Headers

Response

Errors