# BMGetButtonDetails API Operation (NVP) (/api/nvp-soap/get-button-details-nvp)



Shows information about a hosted PayPal Payments Standard button.

> **Note:** **Important:**
>
> The Button Manager API is deprecated. For new integrations, see the associated topic.
>
> | Button                                          | See                                                                                  |
> | ----------------------------------------------- | ------------------------------------------------------------------------------------ |
> | **Buy Now**<br />                               | [PayPal Checkout Overview](/checkout)<br />                                          |
> | **Add to Cart**<br />                           | [Solution Providers](https://www.paypal.com/us/webapps/mpp/solution-providers)<br /> |
> | **Donate**<br />                                | [Create a Donate button](/api/nvp-soap/paypal-payments-pro)<br />                    |
> | **Automatic Billing**<br /> **Subscribe**<br /> | [Subscriptions Overview](/subscriptions/about)<br />                                 |

You can use this information to set the fields that have not changed when updating a button.

## BMGetButtonDetails request [#bmgetbuttondetails-request]

The request includes only the ID of the hosted button whose details you want to obtain.

### BMGetButtonDetails request parameters [#bmgetbuttondetails-request-parameters]

| Field<br />            | Description<br />                                                                |
| ---------------------- | -------------------------------------------------------------------------------- |
| `METHOD`<br />         | *(Required)* `BMGetButtonDetails`<br />                                          |
| `HOSTEDBUTTONID`<br /> | *(Required)* The ID of the hosted button whose details you want to obtain.<br /> |

## BMGetButtonDetails response [#bmgetbuttondetails-response]

The response fields contain all non-inventory information related to the button.

### BMGetButtonDetails response fields [#bmgetbuttondetails-response-fields]

| Field<br />            | Description<br />                                                                                                                                                                                                                                                                                                                                                                 |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `BUTTONTYPE`<br />     | The kind of button. Value is:<br /> <br />`BUYNOW`. The **Buy Now** button.<br />`CART`. The **Add to Cart** button.<br />`SUBSCRIBE`. The **Subscribe** button.<br />`DONATE`. The **Donate** button.<br />`UNSUBSCRIBE`. The **Unsubscribe** button.<br />`VIEWCART`. The **View Cart** button.<br />`AUTOBILLING`. The **Automatic Billing** button. Since version 63.0.<br /> |
| `BUTTONCODE`<br />     | The kind of button code. Value is:<br /> <br />`HOSTED`. A secure button stored on PayPal.<br />`ENCRYPTED`. An encrypted button, not stored on PayPal.<br />`CLEARTEXT`. An unencrypted button, not stored on PayPal.<br />                                                                                                                                                      |
| `BUTTONSUBTYPE`<br />  | The use of button. Value is:<br /> <br />`PRODUCTS`. The button is used to purchase products.<br />`SERVICES`. The button to purchase services.<br />                                                                                                                                                                                                                             |
| `HOSTEDBUTTONID`<br /> | ID of a PayPal-hosted button.<br />                                                                                                                                                                                                                                                                                                                                               |
| `WEBSITECODE`<br />    | HTML code for web pages<br />                                                                                                                                                                                                                                                                                                                                                     |
| `EMAILLINK`<br />      | Code for email links and links in other documents that support external links<br />                                                                                                                                                                                                                                                                                               |
| `L_BUTTONVARn`<br />   | HTML standard button variables<br />                                                                                                                                                                                                                                                                                                                                              |

### Option details fields [#option-details-fields]

| Field<br />         | Description<br />                                                                                                                                                                               |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `OPTIONnNAME`<br /> | *(Optional)* The menu name.<br /> It is one or more variables, in which n is a digit between 0 and 4, inclusive, for hosted buttons; otherwise, it is a digit between 0 and 9, inclusive.<br /> |

### Option selection details fields [#option-selection-details-fields]

| Field                    | Description                                                                                                                                                                                                                                                                 |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `L_OPTIONnSELECTx`<br /> | *(Optional)* The menu item's name<br /> It is a list of variables for each `OPTIONnNAME`, in which x is a digit between 0 and 9, inclusive<br />                                                                                                                            |
| `L_OPTION0PRICEx`<br />  | *(Optional)* The price associated with the first menu item.<br /> It is a list of variables for each `OPTION0NAME`, in which x is a digit between 0 and 9, inclusive<br /> > **Note:** &#x2A;*Note:** If you specify a price, you cannot set a button variable to `amount`. |

## BMGetButtonDetails errors [#bmgetbuttondetails-errors]

| Error code | Short and long messages                                                                                                         | User action                                                                                                                                                                                             |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 10001      | Internal Error<br />Internal Error                                                                                              | To learn more about possible causes and corrective actions, see [What is API error code 10001?](https://www.paypal-knowledge.com/infocenter/index?page=content\&expand=true\&locale=en_US\&id=FAQ1041). |
| 11950      | Invalid Data<br />A hosted button ID must be specified.                                                                         |                                                                                                                                                                                                         |
| 11951      | Invalid Argument<br />The hosted button ID specified is invalid.                                                                |                                                                                                                                                                                                         |
| 11951      | Operation Refused<br />Operation not supported for Sample Buttons.                                                              |                                                                                                                                                                                                         |
| 11992      | Invalid Argument<br />You do not have permissions to access this button. Verify the hosted button ID and try the request again. |                                                                                                                                                                                                         |
