OrbitDocs

Retrieve a plan

GET /plans/{id} returns a plan with its merchant, for checkout.

GET/plans/{id}

Path

iduuidrequired

Plan ID. Must be a valid UUID.

Request

curl http://localhost:3001/plans/7c1e2d4a-0f6b-4a8e-9d51-3b2c9a1f6e20

Response 200

{
  "plan": {
    "id": "7c1e2d4a-0f6b-4a8e-9d51-3b2c9a1f6e20",
    "name": "Pro Monthly",
    "usdc_amount": 290000000,
    "interval_seconds": 2592000,
    "merchants": {
      "name": "Drips Labs",
      "wallet_address": "GBXQ...A8S"
    }
  }
}

Errors

StatusWhen
400id is not a valid UUID
404No plan has this id
500Database error

Create a plan

POST /plans creates a recurring plan owned by a merchant.

Record a subscription

POST /subscriptions records a subscriber after the onchain handshake.

On this page

PathRequestResponse 200Errors