Skip to content
payrocdevelopers

Reactivate a subscription to resume collection.

Reactivate a subscription to resume collection.

Actors

Merchant / integratorclient

Calls the Payroc API to resume collection for the subscription.

Payroc gatewayapi

The Payroc API surface these steps call.

Sequence

Merchant / integrator
Payroc gateway

Follow the numbered steps in order. Each step is described under Steps.

Steps

Follow the workflow

Simulate API steps with synthetic inputs. Confirm manual steps yourself before continuing.

Interactive workflow tests are unavailable in this profile. Use the linked reference and source files to send API requests with your own client.

  1. 1

    Reactivate subscription

    API request

    Restarts collection for a previously deactivated subscription. POST with no request body; returns 200.

    Merchant / integrator → Payroc gateway

    POST/processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/reactivate
Arazzo workflow source
arazzo: 1.0.0
info:
  title: Reactivate a subscription
  summary: Restart collection for a previously deactivated subscription.
  description: |
    Restarts collection on a previously deactivated subscription (a customer's assignment to a payment plan). POST with no request body; returns 200.
    Agent gotchas:
      - `subscriptionId` is the merchant-assigned string (for example
        `SubRef7654`) used on create, not a gateway-generated id.
      - `reactivateSubscription` requires no request body and no Idempotency-Key
        header.

    To stop collection, use the deactivate-a-subscription workflow - deactivate and reactivate are mutually exclusive collection-state actions.
  version: 1.0.0
sourceDescriptions:
  - name: payroc-api
    url: /openapi.yaml
    type: openapi
workflows:
  - workflowId: reactivate-a-subscription
    x-actors:
      - id: merchant
        name: Merchant / integrator
        type: client
        description: Calls the Payroc API to resume collection for the subscription.
      - id: payroc-gateway
        name: Payroc gateway
        type: api
        description: The Payroc API surface these steps call.
    summary: Reactivate a subscription to resume collection.
    description: |
      Restarts collection for the previously deactivated subscription identified by `subscriptionId` on the terminal (reactivateSubscription). Returns 200.
    inputs:
      type: object
      required:
        - processingTerminalId
        - subscriptionId
      properties:
        processingTerminalId:
          type: string
          description: Unique identifier for the terminal that owns the subscription.
          example: "1234001"
        subscriptionId:
          type: string
          description: Merchant-assigned identifier of the subscription to reactivate.
          example: SubRef7654
    steps:
      - stepId: reactivateSubscription
        x-actor: merchant
        x-actor-to: payroc-gateway
        x-label: reactivate request
        description: |
          Restarts collection for a previously deactivated subscription. POST with no request body; returns 200.
        operationId: reactivateSubscription
        parameters:
          - name: processingTerminalId
            in: path
            value: $inputs.processingTerminalId
          - name: subscriptionId
            in: path
            value: $inputs.subscriptionId
        successCriteria:
          - condition: $statusCode == 200
        outputs:
          status: $response.body#/currentState/status
    outputs:
      status: $steps.reactivateSubscription.outputs.status
Download Arazzo

Search documentation

API reference169
Guides118
Knowledge38
legal1
Solutions32
Workflows74
↑↓highlight↵openView all search results

Menu

Theme

Sign out

Your saved plans remain in your organization. This browser’s private draft and account view will be cleared.

Talk to an engineer