Sign in
Memberships

Preview an SMS message for a membership

This endpoint previews an SMS message for a membership.

post/shop/memberships/{membershipId}/sms/preview

Request body

message_type'billing_details_request' required

The type of the SMS message.

always_sendboolean

If true, preview the SMS even if the membership already has a payment method. Defaults to false.

Response

The preview of the SMS message was successfully retrieved

Example response

{
  "data": {
    "message": "Your Premium Membership membership is almost ready! Please provide payment details for your membership payments. Set up here: https://example.com/confirm\n"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.