Skip to main content
PUT
Trigger immediate billing for an order

Headers

X-API-Key
string

Path Parameters

id
integer<int64>
required

Billing Attempt ID

Query Parameters

api_key
string

API Key (Deprecated - Use Header X-API-Key instead)

Response

Billing attempt accepted and queued for immediate processing

Acknowledgement that an immediate billing attempt was accepted and queued for processing. The payment result is delivered asynchronously.

billingAttemptId
integer<int64>

Billing attempt ID that is being processed. Can differ from requestedBillingAttemptId depending on shop settings; use this ID to track the result.

Example:

123457

billingDate
string<date-time>

Billing date of the attempt being processed

contractId
integer<int64>

Subscription contract ID

Example:

987654321

message
string

Human readable description of what happens next

requestedBillingAttemptId
integer<int64>

Billing attempt ID that was passed in the request

Example:

123456

status
enum<string>

Current status of the billing attempt

Available options:
SUCCESS,
FAILURE,
REQUESTING,
PROGRESS,
QUEUED,
SKIPPED,
SOCIAL_CONNECTION_NULL,
CONTRACT_CANCELLED,
CONTRACT_ENDED,
CONTRACT_PAUSED,
AUTO_CHARGE_DISABLED,
SHOPIFY_EXCEPTION,
SKIPPED_DUNNING_MGMT,
SKIPPED_INVENTORY_MGMT,
IMMEDIATE_TRIGGERED,
SECURITY_CHALLENGE,
CONTRACT_PAUSED_MAX_CYCLES,
REFUNDED,
SKIPPED_DEMO_SHOP,
SKIPPED_SHOP_INFO_NOT_FOUND,
SKIPPED_BILLING_DATE_STALE,
SKIPPED_DUNNING_NOT_CONFIGURED,
PENDING_CONSOLIDATION
Example:

"IMMEDIATE_TRIGGERED"