Page cover image

Endpoints

Get User Subscription Details

post

Retrieve the subscription details of a user based on provided email, npub, or external UUID.

Authorizations
Body
emailstringOptional

Email of the user

npubstringOptional

Nostr npub identifier of the user

external_uuidstringOptional

External UUID for identifying the user

flash_idstringOptional

Unique Flash ID associated with the user

Responses
200
Successfully retrieved user subscription details
application/json
post
POST /v1/get_user_subscription_details HTTP/1.1
Host: api.paywithflash.com
Authorization: Bearer JWT
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 71

"email='text'&npub='text'&external_uuid='text'&flash_id='text'"
{
  "membership": {},
  "transactions": [
    {}
  ]
}

Cancel User Subscription

post

Cancel an active subscription for a user based on email, npub, or external UUID.

Authorizations
Body
emailstringOptional

Email of the user

npubstringOptional

Nostr npub identifier of the user

external_uuidstringOptional

External UUID for identifying the user

flash_idstringOptional

Unique Flash ID associated with the user

Responses
200
Subscription successfully canceled
application/json
post
POST /v1/cancel_user_subscription HTTP/1.1
Host: api.paywithflash.com
Authorization: Bearer JWT
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 71

"email='text'&npub='text'&external_uuid='text'&flash_id='text'"
{
  "success": true
}

Last updated