Cratejoy API

Name: Cratejoy API
Brand: Cratejoy API
Availability: InStock

✓ Official Vendor SpecE CommerceOrder Managementbasic32 EndpointsREST

For Agents

Manage subscription orders, renewals, cancellations, and shipments for a Cratejoy subscription-box merchant. Use when an agent needs to drive subscription commerce lifecycle actions on Cratejoy.

Install Jentic One Beta

Connect the Cratejoy API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Cratejoy API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Cratejoy API.

Cancel, reactivate, skip, or renew a subscription via dedicated lifecycle endpoints

Add or remove coupons on an existing subscription

List, create, and update orders for a Cratejoy storefront

Track shipments associated with a subscription order

GET STARTED

Start building with Cratejoy API

Explore with Jentic

View OpenAPI Document

Cratejoy is a subscription commerce platform that lets brands run subscription-box businesses end to end, and the Cratejoy API exposes its merchant data and lifecycle controls. Across 32 endpoints, the API covers orders, subscriptions and their coupons and metadata, products, shipments, customer addresses, and outbound webhooks. Subscription-specific operations include cancel, reactivate, skip the next renewal, and renew a past-due subscription, which together cover the day-to-day churn and recovery actions a subscription merchant needs. Authentication is HTTP Basic with the merchant's API credentials.

Use Cases

Patterns agents use Cratejoy API for, with concrete tasks.

★ Subscription Churn Recovery

When a customer's renewal fails because of an expired card, a churn-recovery workflow uses GET /v1/subscriptions/ to find past-due subscriptions and PUT /v1/subscriptions/{sub_id}/renew/ to retry once the customer updates their card. PUT /v1/subscriptions/{sub_id}/reactivate/ wins back customers who cancelled and changed their mind. This cuts involuntary churn without manual intervention.

Find past-due subscriptions via GET /v1/subscriptions/?state=past_due, then for each one PUT /v1/subscriptions/{sub_id}/renew/ and notify the customer of the result.

Skip-a-Box Self-Service

A subscriber decides to skip their next box because they are travelling. A self-service flow calls PUT /v1/subscriptions/{sub_id}/skip/ to skip the next renewal and PUT /v1/subscriptions/{sub_id}/skip/ again to unskip if plans change. This prevents cancellations driven by inflexibility while keeping the customer's plan intact.

PUT /v1/subscriptions/8821/skip/ to skip the next renewal for a holidaying customer, and confirm the response shows the next renewal pushed by one cycle.

Coupon and Promotion Application

Customer support applies a retention coupon to a subscriber thinking of cancelling. POST /v1/subscriptions/{sub_id}/coupons/ adds the coupon to the active subscription, and DELETE removes it later if the promo expires. GET /v1/subscriptions/{sub_id}/coupons/ confirms which coupons are currently applied so support sees the full picture.

POST /v1/subscriptions/{sub_id}/coupons/ with coupon code 'STAY20' for a churning customer, then GET /v1/subscriptions/{sub_id}/coupons/ to confirm the coupon is active.

Shipment and Address Operations

When a customer moves house, an automation updates their primary shipping address with PUT /v1/store/api/customer/addresses/{address_id}/ and confirms next month's shipment via GET /v1/store/api/shipments/. This avoids the box arriving at the wrong address and reduces support tickets.

PUT /v1/store/api/customer/addresses/{address_id}/ with the new street and postcode, then GET /v1/store/api/shipments/?subscription_id=8821 to confirm next month's box ships to the updated address.

Agent-Driven Subscription Concierge

An AI subscription concierge in a brand's support chat resolves common requests end to end: skipping a box, applying a retention coupon, updating shipping address, or renewing a past-due subscription. Through Jentic, the agent finds the right Cratejoy operation by intent and uses the merchant Basic auth credentials without holding them in plain text.

Search Jentic for 'skip a cratejoy subscription renewal', execute PUT /v1/subscriptions/{sub_id}/skip/, and reply to the customer that their next box has been deferred.

Key Endpoints

32 endpoints — cratejoy is a subscription commerce platform that lets brands run subscription-box businesses end to end, and the cratejoy api exposes its merchant data and lifecycle controls.

METHOD

PATH

DESCRIPTION

PUT

/v1/subscriptions/{sub_id}/cancel/

Cancel a subscription

PUT

/v1/subscriptions/{sub_id}/skip/

Skip or unskip the next renewal

PUT

/v1/subscriptions/{sub_id}/renew/

Renew a past-due subscription

POST

/v1/subscriptions/{sub_id}/coupons/

Add a coupon to a subscription

GET

/v1/orders/

List all orders

GET

/v1/store/api/shipments/

List shipments

POST

/v1/hooks/

Create an outbound webhook

PUT

/v1/subscriptions/{sub_id}/cancel/

Cancel a subscription

PUT

/v1/subscriptions/{sub_id}/skip/

Skip or unskip the next renewal

PUT

/v1/subscriptions/{sub_id}/renew/

Renew a past-due subscription

POST

/v1/subscriptions/{sub_id}/coupons/

Add a coupon to a subscription

GET

/v1/orders/

List all orders

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Cratejoy Basic auth credentials are stored encrypted in the Jentic vault. Jentic injects the Authorization header at execution time and rotates credentials when changed — agents never see them in plain text.

Intent-based discovery

Agents search Jentic with intents like 'cancel a cratejoy subscription' or 'skip the next box' and Jentic returns the matching Cratejoy operation with its input schema, drawn from the 32-endpoint spec.

Time to first call

Direct Cratejoy integration: 1-2 days for Basic auth setup, lifecycle endpoint coverage, and webhook signing. Through Jentic: under 1 hour — search, load, execute.

FAQs

Specific to using Cratejoy API through Jentic.

What authentication does the Cratejoy API use?

Cratejoy uses HTTP Basic authentication with the merchant's API credentials sent in the Authorization header. Through Jentic, the credentials are stored encrypted in the vault and added to outgoing requests at execution time.

Can I cancel a subscription through the Cratejoy API?

Yes. PUT /v1/subscriptions/{sub_id}/cancel/ cancels an active subscription. To bring it back, PUT /v1/subscriptions/{sub_id}/reactivate/ restarts billing at the next cycle.

How do I skip the next box for a subscriber through Jentic?

Search Jentic for 'skip cratejoy subscription renewal', load PUT /v1/subscriptions/{sub_id}/skip/, and execute with the subscription ID. Calling the same endpoint again unskips, which is useful if the customer changes their mind.

Can I apply a coupon to an existing subscription?

Yes. POST /v1/subscriptions/{sub_id}/coupons/ adds a coupon to an active subscription, and DELETE /v1/subscriptions/{sub_id}/coupon/{coupon_id}/ removes it. GET /v1/subscriptions/{sub_id}/coupons/ lists what is currently applied.

What are the rate limits for the Cratejoy API?

The OpenAPI spec does not declare numeric rate limits. Cratejoy enforces fair-use limits at the merchant level. Production integrations should retry on 429 responses with exponential backoff and avoid tight polling.

Does the Cratejoy API support webhooks?

Yes. POST /v1/hooks/ creates an outbound webhook subscription and PUT /v1/hooks/{hook_id}/ updates an existing one. Webhooks let external systems react to subscription and order events without polling.

Cratejoy API

Connect the Cratejoy API to your agent

Capabilities

Start building with Cratejoy API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs