# Getting Started Find information on being a PayPI subscriber here. {% hint style="info" %} Looking for a payment system for your own APIs? Head here for [Partner API Documentation](https://partner.paypi.dev) {% endhint %} ## 1. Subscribing to an API Subscribing to an API that uses PayPI for payments is easy, just follow their PayPI share URL, and follow the instructions to get a [Subscription Secret](/subscriptions#subscription-secret) you can use with the API. [Example Subscription Link](https://app.staging.paypi.dev/subscribe/c2VydmljZTpkMmVhYTU2ZC05NjhhLTQxNWItODAxMy0zYzEzYjEyNmVlOGU=) ## 2. Using an API You will find your [Subscription Secret](/subscriptions#api-secret) on the Subscriptions page, follow the documentation from the API provider to see how to use this in requests. # Subscriptions After you subscribe to an API you can find your API Secret on the subscription page along with analytics, pricing and realtime usage information. ## Payments Subscription payments are taken monthly from your account. You can view your current bills and invoices in the account billing section. ## Usage API usage is recorded in realtime. ## Subscription Secret The key used to authenticate you to the API servers. This is usually passed through the Authorisation header, however this depends on the API provider. You should be able to find information on how to use your API through their documentation. {% hint style="warning" %} Your Subscription Secret should be kept safe as it allows you to be charged for your usage of the API. {% endhint %} # FAQ ## When do I get charged for an API? You are charged for your API usage at the end of each month. For any month that you use an API you are charged 20p + the cost of your API usage. {% hint style="info" %} If you have used a free API or only free charges of an API you are not charged at all for your usage (this includes the 20p monthly fee) {% endhint %} ## How do I use an API? Your [Subscription Secret](/subscriptions#api-secret) which is used to make requests to the API is shown on the subscription page of the API. Documentation can be found on the website of the API Partner (if this is not present and clear, please report this to ) ## How do I add a payment method? To add a payment method to a Team, go to the Team settings by clicking on the icon in the Teams menu. ![Showing Teams menu](https://2838201-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MaiOyUZMLG9WJ1kgpL6%2F-MeKi7o4Jd64hcouxbyH%2F-MeLOJWQuwh5YkFcGDrA%2FScreenshot%202021-07-11%20at%2017.27.34.png?alt=media\&token=e00097f4-1c35-4b27-bb3f-cb0a9d1b6aa9) When in the Team settings, go to the Billing tab and select "Update payment method" to change or add a payment method. ![](https://2838201-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MaiOyUZMLG9WJ1kgpL6%2F-MeKi7o4Jd64hcouxbyH%2F-MeLOURmg-DVoaKgOBK9%2FScreenshot%202021-07-11%20at%2017.28.19.png?alt=media\&token=e4339112-cddb-42ce-97cc-4a78d2b11e70) ## How do I remove my account? You can remove your account for any reason, at any time, by contacting . # Supported Countries ## Supported countries You can create an account and subscribe to APIs from any of the following countries: * United Kingdom (England, Scotland, Wales and Northern Ireland) * United States * Austria * Belgium * Bulgaria * Croatia * Cyprus * Czech Republic * Denmark * Estonia * Finland * France * Germany * Greece * Hungary * Ireland * Italy * Latvia * Lithuania * Luxembourg * Malta * Netherlands * Poland * Portugal * Romania * Slovakia * Slovenia * Spain * Sweden ## My country isn't supported, what can I do? We're sorry you're interested in PayPI but can't get on board. We are working hard to support more countries. We are currently unable to create accounts for users in countries that aren't supported, but we are open to requests to support new countries. Just drop us an email to . # Terms and Conditions By accessing and using this service, you accept and agree to be bound by the terms and provision of this agreement. In addition, when using these particular services, you shall be subject to any posted guidelines or rules applicable to such services. Any participation in this service will constitute acceptance of this agreement. If you do not agree to abide by the above, please do not use this service. {% hint style="info" %} Given that PayPI is currently in Beta, it is expected that there may be issues with the platform. We kindly ask that any issues found with the platform are reported as soon as possible, to or through the live chat on our website. {% endhint %} ## The PayPI Service We agree to provide you with access to the PayPI service. This includes API subscriptions, key handling, account management facilities as well as API partner services that allow selling APIs on the platform. ### Our commitments to API Creators / Partners * We agree to provide API creators with the PayPI service, allowing them to take payments for their APIs. * We agree to pay into a partners account, a percentage of their revenue earned on the site minus taxes (unless fraudulent, illegal, or otherwise erroneous). This percentage shall be 92% unless otherwise discussed and agreed. The amount paid is also subject to currency conversion and external payment handling fees. #### Partner service agreement As a PayPI partner, you agree to provide access to APIs you have setup with PayPI for the length that they remain on the site. By setting up an API on PayPI, you agree that you own the API and will provide access to subscribers of your API through PayPI. It is required that you remain uptime of more than 99.9% from the date your API received it's first subscriber on PayPI and inform PayPI if your API has expected or unexpected downtime for any reason, in order for us to inform your subscribers. ### Your commitments In return for providing the service to you, we require you to commit to the following terms. #### Who can use PayPI * You must be at least 18 years old. * You or the Company you are signing up for must not have gone insolvent or bankrupt in the last 5 years. * We must not have previously removed or disabled your account * If creating an account in the name of a company you must have permissions from the controlling members of the company. #### Commitments as an API Creator / Partner You agree to become an API Creator / Partner when you agree to setup your account as a Partner account. * You must be clear, and descriptive in how you communicate your API to your subscribers or potential subscribers. It is your responsibility to ensure your users are clear on what your API is offering and at what price. * If you are unclear or mislead subscribers, we reserve the right to reverse transactions made and take back or seek to reverse any payments made that were due to misleading or unclear API descriptions or messages either on the PayPI platform or a third party site. * The use of our Partner SDK (or any request to `api.paypi.dev`) is to be used reasonably and responsibly. * You are required to inform us if you plan or expect for your API to make more than 70 requests to us in a single second. * You are responsible for any trademark of copyright infringement brought about by the name, descriptions or images shown on your API. We reserve the right to remove or limit APIs where requested by original copyright/trademark holders. #### Commitments as an API Subscriber As a subscriber you agree to use the APIs you subscribe to as well as the PayPI service fairly. This includes making requests non-maliciously and not using either the API or the PayPI service in a way in which may cause them harm. You agree to pay the prices described on an API when making any request to that API with your 'Subscriber Secret'. It is your responsibility to ensure that requests are made as frequently as you need and we cannot issue refunds for requests made in error. ### Rights we reserve * We reserve the right to remove your account and delete your information from our systems at any time, without prior warning. In this instance we will ensure any amount owed to you is sent to your payment card if available and the payments have not been gained illegally, fraudulently or in breach of any our terms. * We reserve the right to restrict your account's access to our service in order to ensure a safe and secure environment for other users of the service and in the case of non-payment. # Privacy Policy Privacy Policy for PayPI ### **Our contact details** Privacy Coordinator: **Tom Emmerson** Email: **** ### **The type of personal information we collect** We currently collect and process the following information: * First Name * Last Name * Email * Password * Card Details (processed and handled by Stripe) * Usage statistics (for API usage) * IP address ### **How we get the personal information and why we have it** Most of the personal information we process is provided to us directly by you for one of the following reasons: * To provide you with the core features of PayPI - login, subscribing to APIs etc. * To handle disputes between parties on the platform. We use the information that you have given us in order to allow you use of the site, for instance to log you in, send you emails about your account (note, not marketing emails) etc. We may share this information with Stripe in order to handle and process payments as well as any legal authority that has the power to request such information in the UK. Under the General Data Protection Regulation (GDPR), the lawful bases we rely on for processing this information are: 1. Your consent. You are able to remove your consent at any time. You can do this by contacting 2. We have a contractual obligation with you to handle your information in order to provide the services we offer ### **How we store your personal information** Your information is securely stored in the UK. We keep the personal information given to us (listed above) until the account you have created is deleted or you have asked us to remove your information via email or other contact method. We will then dispose your information by removing it from our database. **Your data protection rights** Under data protection law, you have rights including: **Your right of access** - You have the right to ask us for copies of your personal information. **Your right to rectification** - You have the right to ask us to rectify personal information you think is inaccurate. You also have the right to ask us to complete information you think is incomplete. **Your right to erasure** - You have the right to ask us to erase your personal information in certain circumstances. **Your right to restriction of processing** - You have the right to ask us to restrict the processing of your personal information in certain circumstances. **Your right to object to processing** - You have the the right to object to the processing of your personal information in certain circumstances. **Your right to data portability** - You have the right to ask that we transfer the personal information you gave us to another organisation, or to you, in certain circumstances. You are not required to pay any charge for exercising your rights. If you make a request, we have one month to respond to you. Please contact us at if you wish to make a request. ### **How to complain** If you have any concerns about our use of your personal information, you can make a complaint to us at You can also complain to the ICO if you are unhappy with how we have used your data. The ICO’s address: Information Commissioner’s Office\ Wycliffe House\ Water Lane\ Wilmslow\ Cheshire\ SK9 5AF Helpline number: 0303 123 1113 ICO website: