members.dev
Subscription interruptions

Delete an Interruption

Deletes a Subscription Interruption

DELETE
/v1/subscriptions/{subscription_id}/interruptions/{interruption_id}

Authorization

HTTPBearer
AuthorizationBearer <token>

In: header

Path Parameters

subscription_id*string
interruption_id*string

Query Parameters

dry_run?boolean

When true, returns the interruption and the projected Subscription (invoices, credit notes, billing periods), then rolls back.

Defaultfalse

Header Parameters

Members-Context?string

Members organization id (org_…) when the client has multiple organizations.

Default""

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X DELETE "https://api.members.dev/v1/subscriptions/string/interruptions/string"
{
  "interruption": {
    "id": "string",
    "subscription_id": "string",
    "type": "pause",
    "status": "scheduled",
    "starts_at": null,
    "ends_at": {},
    "resumed_at": {},
    "revoked_at": {},
    "created_at": null,
    "updated_at": null
  },
  "subscription": {
    "id": "string",
    "short_id": "string",
    "billing_member_id": "string",
    "default_payment_method": {
      "id": "string",
      "type": "offline",
      "label": "string",
      "is_off_session": true,
      "member_id": "string",
      "details": {}
    },
    "member_ids": [
      "string"
    ],
    "status": "trialing",
    "pending_payment_id": "string",
    "client_secret": "string",
    "product": {
      "product_id": "string",
      "start": {
        "start_type": "auto"
      },
      "recurring": {
        "recurring_type": "never"
      },
      "expiry": {
        "expiry_type": "never"
      },
      "trial": {
        "interval": "week",
        "interval_count": 7
      },
      "price": {
        "price_type": "fixed",
        "price_id": "string",
        "amount": 0,
        "currency": "string"
      },
      "joining_fee_amount": 0,
      "max_members": 0,
      "benefit_schedules": [
        {
          "recurring": {
            "recurring_type": "never"
          },
          "expiry": {
            "expiry_type": "never"
          },
          "benefit_grants": [
            {
              "benefit_id": "string",
              "value_initial": 0,
              "expiry": {
                "expiry_type": "never"
              }
            }
          ]
        }
      ]
    },
    "joining_fee_amount": 0,
    "trial_starts_at": {},
    "trial_ends_at": {},
    "current_period_starts_at": {},
    "current_period_ends_at": {},
    "billing_starts_at": {},
    "prorate_start": true,
    "starts_at": null,
    "expires_at": {},
    "benefit_schedules": [
      "string"
    ],
    "state_transitions": {
      "trialing_at": {},
      "pending_at": {},
      "active_at": {},
      "past_due_at": {},
      "canceled_at": {},
      "expired_at": {},
      "paused_at": {}
    },
    "next_update": {
      "updates_at": null,
      "update_type": "activates"
    },
    "invoices": [
      {
        "id": "string",
        "invoice_number": "INV-550",
        "member_id": "string",
        "status": "draft",
        "collection_status": "none",
        "active_payment_id": "string",
        "due_at": null,
        "amount_original": 0,
        "amount_due": 0,
        "currency": "string",
        "lines": [
          {
            "id": "string",
            "description": "string",
            "quantity": 0,
            "unit_amount": 0,
            "amount": 0
          }
        ],
        "credit_note_allocations": [
          {
            "id": "string",
            "credit_note_id": "string",
            "credit_note_number": "CN-12",
            "amount": 0,
            "currency": "str",
            "created_at": null
          }
        ],
        "payment_allocations": [
          {
            "id": "string",
            "payment_id": "string",
            "status": "pending",
            "amount": 0,
            "currency": "str",
            "notes": "string",
            "payment_method_id": "string",
            "failure_code": "string",
            "failure_message": "string",
            "created_at": null
          }
        ],
        "subscription": {
          "subscription_id": "string",
          "period_starts_at": {},
          "period_ends_at": {}
        },
        "state_transitions": {
          "opened_at": {},
          "past_due_at": {},
          "paid_at": {},
          "voided_at": {},
          "deleted_at": {}
        },
        "next_update": {
          "updates_at": null,
          "update_type": "past_due"
        },
        "created_at": null,
        "updated_at": null
      }
    ],
    "credit_notes": [
      {
        "id": "string",
        "credit_note_number": "CN-12",
        "member_id": "string",
        "currency": "string",
        "amount": 0,
        "allocated_amount": 0,
        "remaining_amount": 0,
        "status": "open",
        "lines": [
          {
            "id": "string",
            "subscription_billing_period_id": "string",
            "subscription_id": "string",
            "description": "string",
            "quantity": 0,
            "unit_amount": 0,
            "amount": 0,
            "sort_order": 0,
            "created_at": null,
            "updated_at": null
          }
        ],
        "allocations": [
          {
            "id": "string",
            "amount": 0,
            "currency": "str",
            "type": "invoice_application",
            "invoice_id": "string",
            "created_at": null,
            "updated_at": null
          }
        ],
        "created_at": null,
        "updated_at": null
      }
    ],
    "billing_periods": [
      {
        "id": "string",
        "starts_at": null,
        "ends_at": {},
        "kind": "string",
        "total_days": 0,
        "active_days": 0,
        "base_amount": 0,
        "target_billable_amount": 0,
        "net_target": 0,
        "currency": "string",
        "status": "upcoming",
        "events": [
          {
            "id": "string",
            "type": "period_materialized",
            "occurred_at": null,
            "amount": 0,
            "currency": "string",
            "interruption_id": "string",
            "invoice_id": "string",
            "payment_id": "string",
            "credit_note_id": "string",
            "starts_at": {},
            "ends_at": {},
            "active_days": 0,
            "previous_active_days": 0,
            "target_billable_amount": 0,
            "previous_target_billable_amount": 0,
            "payload": {},
            "children": [
              {}
            ]
          }
        ]
      }
    ],
    "created_at": null,
    "updated_at": null
  }
}
{
  "type": "https://api.members.dev/errors/invalid_credentials",
  "title": "Invalid credentials",
  "status": 401,
  "detail": "Invalid API Key or token.",
  "code": "invalid_credentials"
}
{
  "type": "https://api.members.dev/errors/not_linked_to_tenant",
  "title": "Not linked to tenant",
  "status": 403,
  "detail": "Not linked to this tenant",
  "code": "not_linked_to_tenant"
}
{
  "type": "https://api.members.dev/errors/member_not_found",
  "title": "Member not found",
  "status": 404,
  "detail": "No member exists with the given id in this organization.",
  "code": "member_not_found"
}
{
  "type": "https://api.members.dev/errors/members_context_required",
  "title": "Members context required",
  "status": 422,
  "detail": "This client has multiple organizations. Send the Members-Context header with the organization id (org_…) for this request.",
  "code": "members_context_required"
}
{
  "type": "https://api.members.dev/errors/rate_limit_exceeded",
  "title": "Rate limit exceeded",
  "status": 429,
  "detail": "Rate limit exceeded",
  "code": "rate_limit_exceeded"
}