Get recurring payment

GET/v1/payments/recurring-payments/{id}Run in dashboard

Requires an API key with the recurring.read action.

Path parametersCopy Anchor Link

• id · string · required · min length 1 · example prp_example

  SDP recurring payment record ID.

HeadersCopy Anchor Link

• x-project-id · string · min length 1 · example prj_example

  Required for dashboard sessions. API keys use their assigned project.

ResponsesCopy Anchor Link

• 200 Recurring payment

  • data · object · required

    Recurring payment response payload.

    • recurringPayment · object · required

      SDP-custody outbound recurring payment record.

      • id · string · required · example prp_example

        SDP recurring payment ID.

      • organizationId · string · required · min length 1 · example org_example

        Organization identifier.

      • projectId · string · required · min length 1 · example prj_example

        Project identifier.

      • sourceCustodyWalletId · string | null · required · example cwlt_example

        Exact source SDP Wallet ID, or null for unresolved legacy records.

      • sourceProviderWalletId · string · required · min length 1 · example privy_wallet_123

        Source Provider wallet ID retained as evidence.

      • sourceAddress · string · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        Source wallet address.

      • counterpartyId · string · required · example cpty_example

        Counterparty ID.

      • counterpartyAccountId · string · required · example cpacct_example

        Counterparty account ID.

      • destinationAddress · string · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        Counterparty wallet owner address.

      • destinationTokenAccount · string | null · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        Derived counterparty token account used for collection.

      • token · string · required

        SPL token mint address.

      • amount · string · required · example 100.00

        Token amount in UI units (decimal string).

      • periodHours · integer · required · greater than 0 · example 720

      • firstCollectionAt · string | null · required · format date-time · example 2025-01-01T00:00:00.000Z

        Requested first collection timestamp.

      • nextCollectionDueAt · string | null · required · format date-time · example 2025-01-01T00:00:00.000Z

        Next due collection timestamp.

      • planId · string | null · required

        Linked SDP subscription plan ID.

      • subscriptionId · string | null · required

        Linked SDP subscription ID.

      • planPda · string | null · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        On-chain plan PDA.

      • planCreatedAt · string | null · required

        On-chain plan createdAt value as an unsigned integer string.

      • planCreationSignature · string | null · required

        Solana signature for plan creation.

      • subscriptionPda · string | null · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        On-chain subscription PDA.

      • subscriptionAuthorityAddress · string | null · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        On-chain subscription authority address.

      • authorizationSignature · string | null · required

        Solana signature for subscription authorization.

      • status · string · required · one of pending_activation, activating, active, updating, canceling, resuming, paused, canceled, expired · example active

        Recurring payment status.

      • pausedReason · string | null · required · one of custody_policy_refused, failed_attempts · example null

        Why SDP paused the recurring payment, set exactly while status is paused: custody_policy_refused when the custody provider's policy refused to sign a collection, failed_attempts when one due period failed 5 times. Resume clears it.

      • metadataUri · string | null · required

        Optional plan metadata URI.

      • createdBy · string | null · required

        Creator user ID or API key ID.

      • createdAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

      • updatedAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

    • tokenApproval · object

      Present when the recurring payment is canceled, on the cancel response and on get: what became of the token approval it relied on.

      • status · string · required · one of revoked, kept, revoking · example kept

        revoked once the approval has been revoked since the cancel. kept while other live recurring payments on the same wallet and token, in this or another project, still use it; sharedWith lists the ones in this project. It is revoked once the last of them ends. revoking when nothing else uses it but the revoke has not confirmed yet, for example while a collection that was already processing settles; the background sweep finishes it.

      • delegate · string · required · min length 32 · max length 44 · example So11111111111111111111111111111111111111112

        The approval's delegate: the Subscriptions program's authority for this wallet and token.

      • sharedWith · object[] · required

        The other live recurring payments in this project on the same wallet and token that keep the approval. Empty unless status is kept, and empty then when only recurring payments in other projects keep it.

        • id · string · required · example prp_example

          SDP recurring payment ID.

        • status · string · required · one of pending_activation, activating, active, updating, canceling, resuming, paused, canceled, expired · example active

          Recurring payment status.

  • meta · object · required

    Response metadata.

    • requestId · string · required · min length 1 · example req_example

      Request identifier for tracing.

    • timestamp · string · required · format date-time · example 2025-01-01T00:00:00.000Z

      ISO 8601 timestamp.

• 401 Unauthorized

  • error · object · required

    Standard error payload.

    • code · string · required

      Machine-readable error code.

    • message · string · required

      Human-readable error message.

    • details · object

      Optional error details for debugging.

      • * · any

  • meta · object

    • requestId · string · min length 1 · example req_example

      Request identifier for tracing.

• 403 Forbidden. Requires the recurring.read action: an API key must hold it (a module's manage or execute also covers its read), and a signed-in member's organization role must include it. Without it the error is INSUFFICIENT_PERMISSIONS and error.details.action names the action. Any other 403 names its own reason.

  Same fields as 401.

• 404 Not Found

  Same fields as 401.

• 500 Internal Server Error

  Same fields as 401.