Skip to content

Ship a subscription immediately

POST
/api/subscriptions/{id}/ship-now
curl --request POST \
--url https://api.usegro.co/api/subscriptions/example/ship-now \
--header 'Content-Type: application/json' \
--data '{ "delivery_date": "example", "slot_id": "example", "production_date": "example" }'

Triggers immediate billing and shipment of a subscription. The job runs asynchronously; the response confirms the billing attempt has been initiated.

id
required
string
Media typeapplication/json
object
delivery_date
string
slot_id
string
production_date
string

Example generated

{
"delivery_date": "example",
"slot_id": "example",
"production_date": "example"
}

Billing attempt initiated

Media typeapplication/json
object
success
required
boolean
message
required
string

Example generated

{
"success": true,
"message": "example"
}

Subscription is not billable or has no Shopify contract

Media typeapplication/json

Example

{
"success": false,
"error": "Subscription is not billable: PAUSED",
"errorCode": "NOT_BILLABLE"
}