PATCH
/
collect
/
payment_pages
/
{id}
/
inactive
Mark Payment Page as Inactive
curl --request PATCH \
  --url https://api.momentco.io/collect/payment_pages/{id}/inactive \
  --header 'Authorization: Bearer <token>'
{
  "id": "pp_EVT9283NAKSD8234SKJD",
  "status": "inactive",
  "page_url": "https://pages.momentpay.io/WELLNESS2025",
  "amount": 15000,
  "currency": "KES",
  "title": "Wellness Retreat - Nairobi",
  "description": "One-day guided wellness and meditation retreat",
  "return_url": "https://retreats.example.com/thank-you",
  "requires_customer_details": true,
  "metadata": {
    "event_id": "wellness_nairobi_2025",
    "category": "event_registration"
  },
  "custom_fields": [
    {
      "key": "session_choice",
      "label": "Preferred Session",
      "type": "dropdown",
      "required": true,
      "options": [
        "Morning (8AM–12PM)",
        "Afternoon (2PM–6PM)"
      ]
    },
    {
      "key": "dietary_restrictions",
      "label": "Any Dietary Restrictions?",
      "type": "text",
      "required": false,
      "default_value": "None"
    },
    {
      "key": "referral_code",
      "label": "Referral Code",
      "type": "text",
      "required": false
    }
  ],
  "created_at": "2025-06-16T10:30:00Z",
  "updated_at": "2025-06-28T15:45:00Z"
}

Authorizations

​
Authorization
string
header
required

Authentication using Bearer tokens. Include your API key in the Authorization header.

Key Types:

  • Test Keys: sk_test_* for development and testing
  • Live Keys: sk_* for production environments
  • Public Keys: pk_test_* or pk_* for client-side operations

📩 Need access? Contact Support to request your API keys.

Usage:

Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc

Path Parameters

​
id
string
required

Unique identifier for the payment page. Must be a valid payment page ID.

Example:

"pp_SjSA234ADKA25245ADJKS"

Response

200
application/json

Payment page marked as inactive successfully

A payment page represents a configurable payment collection interface that can be shared with customers. Payment pages support both fixed and variable amounts with customizable fields for data collection.