Share via


Buy Me A Coffee (Independent Publisher) (Preview)

Buy Me a Coffee makes supporting fun and easy. In just a couple of taps, your fans can make the payment (buy you a coffee) and leave a message. They don't even have to create an account!

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://www.buymeacoffee.com/
Privacy policy https://www.buymeacoffee.com/privacy-policy
Categories Social Media;Website

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Token securestring The Token for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get a member

This endpoint will return membership details by passing its unique identifier.

Get extras (BETA)

Get all your Extras purchases data.

Get extras by ID (BETA)

This endpoint provides data about all of your extra purchases by its unique ID. Please note ID is the same as the Purchase ID returned in the response.

Get members

This endpoint will return all of your members with both active and inactive statuses.

Get onetime-supporters

This endpoint returns all of your onetime supporters and their messages, if any.

Get onetime-supporters by ID

This endpoint will return all of your onetime supporters and their messages by their unique ID.

Get a member

This endpoint will return membership details by passing its unique identifier.

Parameters

Name Key Required Type Description
Identifier
id True integer

The unique identifier of the member.

Returns

Name Path Type Description
Subscription ID
subscription_id integer

The identifier of the subscription.

Subscription Cancelled On
subscription_cancelled_on string

When the subscription was cancelled on.

Subscription Created On
subscription_created_on string

When the subscription was created on.

Subscription Updated On
subscription_updated_on string

When the subscription was updated on.

Subscription Current Period Start
subscription_current_period_start string

When the subscription current period started.

Subscription Current Period End
subscription_current_period_end string

When the subscription current period ends.

Subscription Coffee Price
subscription_coffee_price string

The subscription coffee price.

Subscription Coffee Num
subscription_coffee_num integer

The subscription coffee number.

Subscription Is Cancelled
subscription_is_cancelled string

If the subscription is cancelled.

subscription_is_cancelled_at_period_end
subscription_is_cancelled_at_period_end string

When the subscription is cancelled at period end.

Subscription Currency
subscription_currency string

The subscription currency.

Subscription Message
subscription_message string

The subscription message.

Message Visibility
message_visibility integer

The visibility of the message.

Subscription Duration Type
subscription_duration_type string

The subscription duration type.

Referer
referer string

The referer.

Country
country string

The country.

Transaction ID
transaction_id string

The identifier of the transaction.

Payer Email
payer_email string

The payer's email.

Payer Name
payer_name string

The payer's name.

Get extras (BETA)

Get all your Extras purchases data.

Returns

Name Path Type Description
Current Page
current_page integer

The current page number.

Data
data array of object
Purchase ID
data.purchase_id integer

The identifier of the purchase.

Purchased On
data.purchased_on string

When purchased on.

Purchase Updated On
data.purchase_updated_on string

When purchase was updated on.

Purchase Is Revoked
data.purchase_is_revoked integer

Whether the purchase is revoked.

Purchase Amount
data.purchase_amount string

The amount of the purchase.

Purchase Currency
data.purchase_currency string

The purchase currency.

Purchase Question
data.purchase_question string

The purchase question.

Payer Email
data.payer_email string

The payer's email adress.

Payer Name
data.payer_name string

The payer's name.

Reward ID
data.extra.reward_id integer

The identifier of the reward.

Reward Title
data.extra.reward_title string

The reward title.

Reward Description
data.extra.reward_description string

The reward description.

Reward Confirmation Message
data.extra.reward_confirmation_message string

The reward confirmation message.

Reward Question
data.extra.reward_question string

The reward question.

Reward Used
data.extra.reward_used integer

The number of rewards used.

Reward Created On
data.extra.reward_created_on string

When the reward was created on.

Reward Updated On
data.extra.reward_updated_on string

When the reward was updated on.

Reward Deleted On
data.extra.reward_deleted_on string

When the reward was deleted on.

Reward Is Active
data.extra.reward_is_active integer

If the reward is active.

Reward Image
data.extra.reward_image string

The reward image.

Reward Slots
data.extra.reward_slots integer

The reward slots.

Reward Coffee Price
data.extra.reward_coffee_price string

The reward coffee price.

Reward Order
data.extra.reward_order integer

The reward order number.

First Page URL
first_page_url string

The URL of the first page.

From
from integer

The from number.

Last Page
last_page integer

The last page number.

Last Page URL
last_page_url string

The URL of the last page.

Next Page URL
next_page_url string

The URL of the next page.

Path
path string

The path.

Per Page
per_page integer

The number per page.

Prev Page URL
prev_page_url string

The URL of the previous page.

To
to integer

The to number.

Total
total integer

The total number.

Get extras by ID (BETA)

This endpoint provides data about all of your extra purchases by its unique ID. Please note ID is the same as the Purchase ID returned in the response.

Parameters

Name Key Required Type Description
Identifier
id True integer

The unique identifier.

Returns

Name Path Type Description
Purchase ID
purchase_id integer

The identifer of the purchase.

Purchased On
purchased_on string

When the extra was purchased on.

Purchase Updated On
purchase_updated_on string

When the extra was updated on.

Purchase Is Revoked
purchase_is_revoked integer

If the purchase is revoked.

Purchase Amount
purchase_amount string

The purchase amount.

Purchase Currency
purchase_currency string

The purchase currency.

Purchase Question
purchase_question string

The purchase question.

Payer Email
payer_email string

The payer's email address.

Payer Name
payer_name string

The payer's name.

Reward ID
extra.reward_id integer

The identifier of the reward.

Reward Title
extra.reward_title string

The reward title.

Reward Description
extra.reward_description string

The reward description.

Reward Confirmation Message
extra.reward_confirmation_message string

The reward confirmation message.

reward_question
extra.reward_question string

The reward question.

reward_used
extra.reward_used integer

The number of rewards used.

reward_created_on
extra.reward_created_on string

When the reward was created on.

reward_updated_on
extra.reward_updated_on string

When the reward was updated on.

reward_deleted_on
extra.reward_deleted_on string

When the reward was deleted on.

reward_is_active
extra.reward_is_active integer

If the reward is active.

reward_image
extra.reward_image string

The reward image.

reward_slots
extra.reward_slots integer

The reward slots.

reward_coffee_price
extra.reward_coffee_price string

The reward coffee price.

reward_order
extra.reward_order integer

The reward order number.

Get members

This endpoint will return all of your members with both active and inactive statuses.

Parameters

Name Key Required Type Description
Status
status string

All, active or inactive status.

Returns

Name Path Type Description
Current Page
current_page integer

The current page number.

Data
data array of object
Subscription ID
data.subscription_id integer

The identifier of the subscription.

Subscription Cancelled On
data.subscription_cancelled_on string

When the subsciption was cancelled on.

Subscription Created On
data.subscription_created_on string

When the subsciption was created on.

Subscription Updated On
data.subscription_updated_on string

When the subsciption was updated on.

Subscription Current Period Start
data.subscription_current_period_start string

When the subsciption current period started.

Subscription Current Period End
data.subscription_current_period_end string

When the subsciption current period ended.

Subscription Coffee Price
data.subscription_coffee_price string

The subscription coffee price.

Subscription Coffee Num
data.subscription_coffee_num integer

The subscription coffee number.

Subscription Is Cancelled
data.subscription_is_cancelled string

If the subscription is cancelled.

subscription_is_cancelled_at_period_end
data.subscription_is_cancelled_at_period_end string

If the subscription is cancelled at period end.

Subscription Currency
data.subscription_currency string

The subscription currency.

Subscription Message
data.subscription_message string

The subscription message.

Message Visibility
data.message_visibility integer

The visibility of the message.

Subscription Duration Type
data.subscription_duration_type string

The subscription duration type.

Referer
data.referer string

The referer.

Country
data.country string

The country.

Transaction ID
data.transaction_id string

The identifier of the transaction.

Payer Email
data.payer_email string

The payer's email address.

Payer Name
data.payer_name string

The payer's name.

First Page URL
first_page_url string

The URL of the first page.

From
from integer

The from number.

Last Page
last_page integer

The last page number.

Last Page URL
last_page_url string

The URL of the last page.

Next Page URL
next_page_url string

The URL of the next page.

Path
path string

The path.

Per Page
per_page integer

The number per page.

Prev Page URL
prev_page_url string

The URL of the previous page.

To
to integer

The to number.

Total
total integer

The total number.

Get onetime-supporters

This endpoint returns all of your onetime supporters and their messages, if any.

Returns

Name Path Type Description
Current Page
current_page integer

The current page number.

Data
data array of object
Support ID
data.support_id integer

The identifier of the supporter.

Support Note
data.support_note string

The support noter.

Support Coffees
data.support_coffees integer

The number of support coffees.

Transaction ID
data.transaction_id string

The identifier of the transaction.

Support Visibility
data.support_visibility integer

The visibility of the support.

Support Created On
data.support_created_on string

When the support was created on.

Support Updated On
data.support_updated_on string

When the support was updated on.

Transfer ID
data.transfer_id string

The identifier of the transfer.

Supporter Name
data.supporter_name string

The name of the supporter.

Support Coffee Price
data.support_coffee_price string

The support coffee price.

Support Email
data.support_email string

The email of the supporter.

Is Refunded
data.is_refunded string

Whether is refunded.

Support Currency
data.support_currency string

The currency of the support.

Support Note Pinned
data.support_note_pinned integer

The number the support note is pinned.

Referer
data.referer string

The referer.

Country
data.country string

The country.

Payer Email
data.payer_email string

The email address of the payer.

Payment Platform
data.payment_platform string

The payment platform.

Payer Name
data.payer_name string

The name of the payer.

First Page URL
first_page_url string

The URL of the first page.

From
from integer

The from number.

Last Page
last_page integer

The last page number.

Last Page URL
last_page_url string

The URL of the last page.

Next Page URL
next_page_url string

The URL of the next page.

Path
path string

The path.

Per Page
per_page integer

The number per page.

Prev Page URL
prev_page_url string

The URL of the previous page.

To
to integer

The to number.

Total
total integer

The total number.

Get onetime-supporters by ID

This endpoint will return all of your onetime supporters and their messages by their unique ID.

Parameters

Name Key Required Type Description
Identifier
id True integer

The unique identifier of the one-time supporter.

Returns

Name Path Type Description
Support ID
support_id integer

The identifier of the support.

Support Note
support_note string

The support note.

Support Coffees
support_coffees integer

The number of support coffees.

Transaction ID
transaction_id string

The identifier of the transaction.

Support Visibility
support_visibility integer

The support visibility.

Support Created On
support_created_on string

When the support was created on.

Support Updated On
support_updated_on string

When the support was updated on.

Transfer ID
transfer_id string

The identifier of the transfer.

Supporter Name
supporter_name string

The supporter's name.

Support Coffee Price
support_coffee_price string

The support coffee price.

Support Email
support_email string

The email address of the support.

Is Refunded
is_refunded string

Whether is refunded.

Support Currency
support_currency string

The currency of the support.

Support Note Pinned
support_note_pinned integer

The number the support note is pinned.

Referer
referer string

The referer.

Country
country string

The country.

Payer Email
payer_email string

The payer's email address.

Payment Platform
payment_platform string

The payment platform.

Payer Name
payer_name string

The payer's name.