Endpoints

Get User Subscription Details

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/x-www-form-urlencoded

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

membershipobjectOptional

Membership details of the user

transactionsobject[]Optional

List of transactions related to the user's subscription

400

Missing required parameters or invalid request

401

Unauthorized or invalid token

500

Internal server error

post

/get_user_subscription_details

HTTPcURLJavaScriptPython

POST /v1/get_user_subscription_details HTTP/1.1
Host: api.paywithflash.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/x-www-form-urlencoded

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

successbooleanOptional

Indicates whether the cancellation was successful

401

Unauthorized or invalid token

404

No subscription found for the given parameters

500

Internal server error

post

/cancel_user_subscription

HTTPcURLJavaScriptPython

POST /v1/cancel_user_subscription HTTP/1.1
Host: api.paywithflash.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 71

"email='text'&npub='text'&external_uuid='text'&flash_id='text'"

{
  "success": true
}