API referenceAdmin drops fee offers

Admin drops fee offers

4 operations. Every schema and example on this page is generated from the platform contract.

Drops fee offers: one shop.

Internal-admin. The shop's live booking-fee offer, what is left of it, and its history.

auth internal-adminop adminDropsFeeOfferReadrate limitederrors

Parameters

storeIdstringpathrequired

Response, 200

offerobjectrequired

The live one, if any.

12 child fields
idstringrequired
store_idstringrequired
kindenumrequired
permanentperioddrop_count
starts_atstringrequired
ends_atstring, nullablerequired

Period only: the first moment after it (midnight UK time after its last day).

period_unitenumrequired
daysmonths
period_lengthnumber, nullablerequired
drop_allowancenumber, nullablerequired

First-N-drops only: how many drops it covers.

revoked_atstring, nullablerequired
used_dropsnumberoptional

Drops it has in use.

planenumoptional

Fee plans: waived (no fee), flat or tiered. Absent from an older database: 'waived'.

waivedflattiered
fee_bandsarray of objectoptional

Flat or tiered only: the bands.

2 child fields
up_to_pencenumber, nullablerequired

The band top in pence, inclusive; null = no top (flat, or the last band).

fee_pencenumberrequired

The fee per order in this band, in pence (0 to 1000).

statusobjectrequired
7 child fields
stateenumrequired
nonescheduledactiveendedrevoked
kindenumrequired
permanentperioddrop_count
lastMomentAtstring, nullablerequired
daysLeftnumber, nullablerequired

UK calendar days left, today included.

dropsLeftnumber, nullablerequired
dropAllowancenumber, nullablerequired
startsAtstring, nullablerequired
grantable_kindsarray of enumrequired
permanentperioddrop_count
grantable_plansarray of enumrequired

Waived always; flat and tiered only while DROPS_FEE_PLANS_ENABLED is on.

waivedflattiered
historyarray of objectrequired
6 child fields
actionstringrequired
atstringrequired
actor_emailstring, nullablerequired
notestring, nullablerequired
kindenumrequired
permanentperioddrop_count
planenumrequired
waivedflattiered
curl -G "https://www.membber.com/api/v1/admin-drops-fee-offers/8fb04ddc-0000-4000-8000-d0c50000008f" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "offer": {
    "id": "00000d1b-0000-4000-8000-d0c500000000",
    "store_id": "6659c139-0000-4000-8000-d0c500000066",
    "kind": "permanent",
    "starts_at": "<starts_at>",
    "ends_at": "<ends_at>",
    "period_unit": "days",
    "period_length": 1,
    "drop_allowance": 1,
    "revoked_at": "<revoked_at>",
    "used_drops": 1,
    "plan": "waived",
    "fee_bands": [
      {
        "up_to_pence": 1500,
        "fee_pence": 1500
      }
    ]
  },
  "status": {
    "state": "none",
    "kind": "permanent",
    "lastMomentAt": "<lastMomentAt>",
    "daysLeft": 1,
    "dropsLeft": 1,
    "dropAllowance": 1,
    "startsAt": "<startsAt>"
  },
  "grantable_kinds": [
    "permanent"
  ],
  "grantable_plans": [
    "waived"
  ],
  "history": [
    {
      "action": "<action>",
      "at": "<at>",
      "actor_email": "alex@example.com",
      "note": "Added at the front desk",
      "kind": "permanent",
      "plan": "waived"
    }
  ]
}

Drops fee offers: change the live one.

Internal-admin. Its length or its number of drops. Needs an Idempotency-Key. Audited.

Parameters

storeIdstringpathrequired

Request body

offer_idstringoptional
period_lengthnumberoptional
drop_allowancenumberoptional
notestringoptional

Why, for the record. Required.

Response, 200

offerobjectrequired
12 child fields
idstringrequired
store_idstringrequired
kindenumrequired
permanentperioddrop_count
starts_atstringrequired
ends_atstring, nullablerequired

Period only: the first moment after it (midnight UK time after its last day).

period_unitenumrequired
daysmonths
period_lengthnumber, nullablerequired
drop_allowancenumber, nullablerequired

First-N-drops only: how many drops it covers.

revoked_atstring, nullablerequired
used_dropsnumberoptional

Drops it has in use.

planenumoptional

Fee plans: waived (no fee), flat or tiered. Absent from an older database: 'waived'.

waivedflattiered
fee_bandsarray of objectoptional

Flat or tiered only: the bands.

2 child fields
up_to_pencenumber, nullablerequired

The band top in pence, inclusive; null = no top (flat, or the last band).

fee_pencenumberrequired

The fee per order in this band, in pence (0 to 1000).

replayedbooleanrequired

True when this Idempotency-Key was already used: the first answer, again.

curl -X PATCH "https://www.membber.com/api/v1/admin-drops-fee-offers/8fb04ddc-0000-4000-8000-d0c50000008f" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  -H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
  -H "Content-Type: application/json" \
  -d '{
    "offer_id": "d230e9de-0000-4000-8000-d0c5000000d2",
    "period_length": 1,
    "drop_allowance": 1,
    "note": "Added at the front desk"
  }'
Response, 200
{
  "offer": {
    "id": "00000d1b-0000-4000-8000-d0c500000000",
    "store_id": "6659c139-0000-4000-8000-d0c500000066",
    "kind": "permanent",
    "starts_at": "<starts_at>",
    "ends_at": "<ends_at>",
    "period_unit": "days",
    "period_length": 1,
    "drop_allowance": 1,
    "revoked_at": "<revoked_at>",
    "used_drops": 1,
    "plan": "waived",
    "fee_bands": [
      {
        "up_to_pence": 1500,
        "fee_pence": 1500
      }
    ]
  },
  "replayed": true
}

Drops fee offers: grant one.

Internal-admin. Sets this shop's booking fee plan: waived, a flat fee per order, or a tiered fee by order size; for good, for a period, or for its first N drops. One plan at a time (replace: true swaps it). Needs an Idempotency-Key. Audited.

Parameters

storeIdstringpathrequired

Request body

kindstringoptional

permanent, period or drop_count.

period_unitstringoptional

Period only: days or months (UK calendar).

period_lengthnumberoptional
drop_allowancenumberoptional
starts_atstringoptional

An offer starts when it is granted; a later start is refused.

planstringoptional

Fee plans: waived (default), flat or tiered. Flat and tiered are refused (409 FEE_PLANS_OFF) while switched off.

fee_bandsarray of objectoptional

Flat: one band with no top. Tiered: 2 to 10 bands, tops rising and inclusive, only the last open.

2 child fields
up_to_pencenumber, nullableoptional
fee_pencenumberrequired
replacebooleanoptional

Revoke the live offer and grant this one in one step (one plan at a time).

notestringoptional

Why, for the record. Required.

Response, 200

offerobjectrequired
12 child fields
idstringrequired
store_idstringrequired
kindenumrequired
permanentperioddrop_count
starts_atstringrequired
ends_atstring, nullablerequired

Period only: the first moment after it (midnight UK time after its last day).

period_unitenumrequired
daysmonths
period_lengthnumber, nullablerequired
drop_allowancenumber, nullablerequired

First-N-drops only: how many drops it covers.

revoked_atstring, nullablerequired
used_dropsnumberoptional

Drops it has in use.

planenumoptional

Fee plans: waived (no fee), flat or tiered. Absent from an older database: 'waived'.

waivedflattiered
fee_bandsarray of objectoptional

Flat or tiered only: the bands.

2 child fields
up_to_pencenumber, nullablerequired

The band top in pence, inclusive; null = no top (flat, or the last band).

fee_pencenumberrequired

The fee per order in this band, in pence (0 to 1000).

replayedbooleanrequired

True when this Idempotency-Key was already used: the first answer, again.

curl -X POST "https://www.membber.com/api/v1/admin-drops-fee-offers/8fb04ddc-0000-4000-8000-d0c50000008f" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  -H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "<kind>",
    "period_unit": "<period_unit>",
    "period_length": 1,
    "drop_allowance": 1,
    "starts_at": "<starts_at>",
    "plan": "<plan>",
    "fee_bands": [
      {
        "fee_pence": 1500
      }
    ],
    "replace": true,
    "note": "Added at the front desk"
  }'
Response, 200
{
  "offer": {
    "id": "00000d1b-0000-4000-8000-d0c500000000",
    "store_id": "6659c139-0000-4000-8000-d0c500000066",
    "kind": "permanent",
    "starts_at": "<starts_at>",
    "ends_at": "<ends_at>",
    "period_unit": "days",
    "period_length": 1,
    "drop_allowance": 1,
    "revoked_at": "<revoked_at>",
    "used_drops": 1,
    "plan": "waived",
    "fee_bands": [
      {
        "up_to_pence": 1500,
        "fee_pence": 1500
      }
    ]
  },
  "replayed": true
}

Drops fee offers: revoke the live one.

Internal-admin. Drops already selling without the fee keep it until they close; paid orders keep what they paid. Needs an Idempotency-Key. Audited.

Parameters

storeIdstringpathrequired

Request body

offer_idstringoptional
notestringoptional

Why, for the record. Required.

Response, 200

offerobjectrequired
12 child fields
idstringrequired
store_idstringrequired
kindenumrequired
permanentperioddrop_count
starts_atstringrequired
ends_atstring, nullablerequired

Period only: the first moment after it (midnight UK time after its last day).

period_unitenumrequired
daysmonths
period_lengthnumber, nullablerequired
drop_allowancenumber, nullablerequired

First-N-drops only: how many drops it covers.

revoked_atstring, nullablerequired
used_dropsnumberoptional

Drops it has in use.

planenumoptional

Fee plans: waived (no fee), flat or tiered. Absent from an older database: 'waived'.

waivedflattiered
fee_bandsarray of objectoptional

Flat or tiered only: the bands.

2 child fields
up_to_pencenumber, nullablerequired

The band top in pence, inclusive; null = no top (flat, or the last band).

fee_pencenumberrequired

The fee per order in this band, in pence (0 to 1000).

replayedbooleanrequired

True when this Idempotency-Key was already used: the first answer, again.

curl -X POST "https://www.membber.com/api/v1/admin-drops-fee-offers/8fb04ddc-0000-4000-8000-d0c50000008f/revoke" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  -H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
  -H "Content-Type: application/json" \
  -d '{
    "offer_id": "d230e9de-0000-4000-8000-d0c5000000d2",
    "note": "Added at the front desk"
  }'
Response, 200
{
  "offer": {
    "id": "00000d1b-0000-4000-8000-d0c500000000",
    "store_id": "6659c139-0000-4000-8000-d0c500000066",
    "kind": "permanent",
    "starts_at": "<starts_at>",
    "ends_at": "<ends_at>",
    "period_unit": "days",
    "period_length": 1,
    "drop_allowance": 1,
    "revoked_at": "<revoked_at>",
    "used_drops": 1,
    "plan": "waived",
    "fee_bands": [
      {
        "up_to_pence": 1500,
        "fee_pence": 1500
      }
    ]
  },
  "replayed": true
}
WhatsApp
Book a Call
Get Started
Admin drops fee offers API | Membber Developers