Skip to main content
POST
Preview a server-authoritative next-order delay

Body

application/json
contractId
integer<int64>
required

Shopify subscription contract ID

Example:

123456789

delayDays
enum<integer>
required

Server-authoritative delay preset. Only 7 or 14 is accepted.

Available options:
7,
14
Example:

7

billingAttemptId
integer<int64>

Exact upcoming billing attempt ID. Required by notification-originated callers.

Example:

987654321

Response

Eligibility result, including allowed, reasonCode, currentBillingDate, and targetBillingDate

allowed
boolean
billingAttemptId
integer<int64>
contractId
integer<int64>
currentBillingDate
string<date-time>
reasonCode
enum<string>
Available options:
ALLOWED,
EXECUTED,
ALREADY_SKIPPED,
ALREADY_RESCHEDULED,
INVALID_REQUEST,
INVALID_DELAY_DAYS,
MISSING_IDEMPOTENCY_KEY,
CONTRACT_NOT_FOUND,
BILLING_ATTEMPT_NOT_FOUND,
BILLING_ATTEMPT_CONTRACT_MISMATCH,
NO_UPCOMING_ORDER,
STALE_BILLING_ATTEMPT,
QUICK_ACTIONS_NOT_ENABLED,
INTEGRATIONS_NOT_ENABLED,
TWO_WAY_SMS_NOT_ENABLED,
PLAN_UPGRADE_REQUIRED,
SKIP_NOT_ALLOWED,
PREPAID_SKIP_NOT_SUPPORTED,
RESCHEDULE_NOT_ALLOWED,
MIN_CYCLES_NOT_COMPLETED,
ATTRIBUTE_MIN_CYCLES_NOT_COMPLETED,
TIME_WINDOW_RESTRICTED,
ORDER_IN_PROGRESS,
FIXED_BILLING_SCHEDULE,
RESTRICTED_DATE,
RESTRICTED_DAY_OF_WEEK,
MUTATION_DECLINED,
MUTATION_FAILED
safeCustomerMessage
string
targetBillingDate
string<date-time>