Skip to main content

Checkouts List

Metodo HTTP: GET

Checkouts List

Checkouts List

Query Parameters
  • q Q
  • order Order
  • state CheckoutState

    Possible values: [OPEN, CLOSED]

    An enumeration.

  • create_date_from date
  • create_date_to date
  • update_date_from date
  • update_date_to date
  • limit Limit

    Possible values: >= 1

    Default value: 100

  • offset Offset
Responses

200

OK

application/jsonSchemaExample (from schema)
Schema
  • items object[]
  • Array [
  • id Id required
  • create_date date-time required
  • update_date date-time required
  • campaign object
  • id Id required
  • create_date date-time required
  • update_date date-time required
  • title Title required
  • slug Slug
  • code Code
  • type Type required
  • goal Goal
  • is_goal_enabled Is Goal Enabled required
  • has_one_off Has One Off required
  • has_subscription Has Subscription required
  • allow_custom_amount Allow Custom Amount required
  • allow_custom_subscription_amount Allow Custom Subscription Amount required
  • default_amount Default Amount
  • default_subscription_amount Default Subscription Amount
  • min_amount Min Amount
  • max_amount Max Amount
  • min_subscription_amount Min Subscription Amount
  • max_subscription_amount Max Subscription Amount
  • asks number[]
  • asks_subscription number[]
  • shown_fields string[]
  • required_fields string[]
  • privacy_note Privacy Note
  • tags string[] required
  • supporter object
  • id Id required
  • create_date date-time required
  • image Image
  • code Code
  • business_name Business Name
  • first_name First Name
  • last_name Last Name
  • email Email
  • phone Phone
  • mobile Mobile
  • job Job
  • sex Sex

    Possible values: [MALE, FEMALE]

    An enumeration.

  • date_of_birth date
  • place_of_birth Place Of Birth
  • ssn Ssn
  • vat Vat
  • address Address
  • address2 Address2
  • city City
  • locality Locality
  • country Country
  • postal_code Postal Code
  • certification_url Certification Url
  • privacy Privacy
  • email_marketing Email Marketing
  • phone_marketing Phone Marketing
  • sms_marketing Sms Marketing
  • postal_marketing Postal Marketing
  • profilation_marketing Profilation Marketing
  • tags string[] required
  • note Note
  • donation object
  • id Id required
  • supporter_id Supporter Id required
  • campaign_id Campaign Id required
  • code Code required
  • state DonationState required

    Possible values: [draft, pending, active, past_due, done, revoked]

    An enumeration.

  • amount Amount required
  • receipt_url Receipt Url
  • frequency Frequency

    Possible values: [0, 12, 1]

    An enumeration.

  • note Note
  • completed_date date-time
  • create_date date-time required
  • update_date date-time required
  • device Device
  • tags string[] required
  • payment object
  • id Id required
  • donation_id Donation Id required
  • state PaymentState required

    Possible values: [PENDING, PAID, REFUNDED, FAILED]

    An enumeration.

  • amount Amount required
  • payment_date date-time
  • payment_method object
  • id Id required
  • create_date date-time required
  • update_date date-time required
  • processor Processor required
  • label Label required
  • stripe_intent_id Stripe Intent Id
  • create_date date-time required
  • update_date date-time required
  • state CheckoutState required

    Possible values: [OPEN, CLOSED]

    An enumeration.

  • amount Amount
  • completed_date date-time
  • frequency Frequency

    Possible values: [0, 12, 1]

    An enumeration.

  • cost_example_quantity Cost Example Quantity required
  • payment_method_processor Payment Method Processor
  • payment_method_label Payment Method Label
  • payment_method_id Payment Method Id
  • ]
  • count Count required
{
  "items": [
    {
      "id": 0,
      "create_date": "2026-10-14T17:23:08.302Z",
      "update_date": "2026-10-14T17:23:08.303Z",
      "campaign": {
        "id": 0,
        "create_date": "2026-10-14T17:23:08.303Z",
        "update_date": "2026-10-14T17:23:08.303Z",
        "title": "string",
        "slug": "string",
        "code": "string",
        "type": "string",
        "goal": 0,
        "is_goal_enabled": true,
        "has_one_off": true,
        "has_subscription": true,
        "allow_custom_amount": true,
        "allow_custom_subscription_amount": true,
        "default_amount": 0,
        "default_subscription_amount": 0,
        "min_amount": 0,
        "max_amount": 0,
        "min_subscription_amount": 0,
        "max_subscription_amount": 0,
        "asks": [
          0
        ],
        "asks_subscription": [
          0
        ],
        "shown_fields": [
          "string"
        ],
        "required_fields": [
          "string"
        ],
        "privacy_note": "string",
        "tags": [
          "string"
        ]
      },
      "supporter": {
        "id": 0,
        "create_date": "2026-10-14T17:23:08.303Z",
        "image": "string",
        "code": "string",
        "business_name": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "phone": "string",
        "mobile": "string",
        "job": "string",
        "sex": "MALE",
        "date_of_birth": "2026-10-14",
        "place_of_birth": "string",
        "ssn": "string",
        "vat": "string",
        "address": "string",
        "address2": "string",
        "city": "string",
        "locality": "string",
        "country": "string",
        "postal_code": "string",
        "certification_url": "string",
        "privacy": true,
        "email_marketing": true,
        "phone_marketing": true,
        "sms_marketing": true,
        "postal_marketing": true,
        "profilation_marketing": true,
        "tags": [
          "string"
        ],
        "note": "string"
      },
      "donation": {
        "id": 0,
        "supporter_id": 0,
        "campaign_id": 0,
        "code": "string",
        "state": "draft",
        "amount": 0,
        "receipt_url": "string",
        "frequency": 0,
        "note": "string",
        "completed_date": "2026-10-14T17:23:08.303Z",
        "create_date": "2026-10-14T17:23:08.303Z",
        "update_date": "2026-10-14T17:23:08.303Z",
        "device": "string",
        "tags": [
          "string"
        ]
      },
      "payment": {
        "id": 0,
        "donation_id": 0,
        "state": "PENDING",
        "amount": 0,
        "payment_date": "2026-10-14T17:23:08.303Z",
        "payment_method": {
          "id": 0,
          "create_date": "2026-10-14T17:23:08.303Z",
          "update_date": "2026-10-14T17:23:08.303Z",
          "processor": "string",
          "label": "string"
        },
        "stripe_intent_id": "string",
        "create_date": "2026-10-14T17:23:08.303Z",
        "update_date": "2026-10-14T17:23:08.303Z"
      },
      "state": "OPEN",
      "amount": 0,
      "completed_date": "2026-10-14T17:23:08.303Z",
      "frequency": 0,
      "cost_example_quantity": 0,
      "payment_method_processor": "string",
      "payment_method_label": "string",
      "payment_method_id": 0
    }
  ],
  "count": 0
}
Loading...

Fonte: https://dev.riseact.org/docs/rest-references/riseact-app-checkouts-rest-api-checkouts-list. Copia automatica da dev.riseact.org: non modificare qui, le modifiche vanno fatte sulla documentazione Docusaurus.