Sign in
Payments

Prepare subscription collection

Prepares the collector-signed Solana subscriptions transfer transaction for an active subscription. The transaction must still be signed and submitted by the collector/fee-payer flow.

post/v1/payments/subscriptions/{subscriptionId}/prepare-collection

Path parameters

subscriptionIdstring required

SDP subscription record ID.

Example:psub_example

SDP subscription record ID.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Request body

receiverTokenAccountstring required

Receiver token account for the pulled subscription payment. It must be allowed by the on-chain plan.

Example request

{
  "receiverTokenAccount": "7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU"
}

Response

Subscription collection prepared

Example response

{
  "data": {
    "subscription": {
      "id": "psub_example",
      "organizationId": "org_example",
      "projectId": "prj_example",
      "subscriberAddress": "So11111111111111111111111111111111111111112",
      "subscriberTokenAccount": "So11111111111111111111111111111111111111112",
      "subscriptionPda": "So11111111111111111111111111111111111111112",
      "subscriptionAuthorityAddress": "So11111111111111111111111111111111111111112",
      "status": "active",
      "currentPeriodStartAt": "2025-01-01T00:00:00.000Z",
      "nextCollectionDueAt": "2025-01-01T00:00:00.000Z",
      "cancelAt": "2025-01-01T00:00:00.000Z",
      "canceledAt": "2025-01-01T00:00:00.000Z",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z"
    },
    "preparedTransaction": {
      "serialized": "AQID",
      "blockhash": "blockhash_example",
      "lastValidBlockHeight": "123456",
      "requiredSigners": [
        "So11111111111111111111111111111111111111112"
      ]
    },
    "collectionAttempt": {
      "id": "psca_example",
      "organizationId": "org_example",
      "projectId": "prj_example",
      "transferId": "xfr_example",
      "amount": "100.00",
      "dueAt": "2025-01-01T00:00:00.000Z",
      "attemptedAt": "2025-01-01T00:00:00.000Z",
      "status": "pending",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes

Changed in 2 of the 9 revisions of this API.6

  • 3e302bba53865See the full diff
    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 500

      response-property-enum-value-added

  • f0006b71f86c1See the full diff
    • ●

      removed the request property amount

      request-property-removed